@etcswapv2/sdk-legacy 1.0.0

package/dist/index.d.mts

@@ -0,0 +1,214 @@
+/**
+ * ETCswap SDK Legacy - Non-generic V2 SDK for Ethereum Classic
+ *
+ * This SDK provides a Uniswap V2-compatible API (non-generic classes) for
+ * ETCswap V2 protocol on Ethereum Classic chains.
+ *
+ * Use this SDK when migrating from the original Uniswap V2 interface or
+ * when you need the simpler non-generic API.
+ *
+ * For new projects, consider using @etcswapv2/sdk which provides a
+ * modern generics-based API.
+ */
+declare enum ChainId {
+    MAINNET = 1,
+    ROPSTEN = 3,
+    RINKEBY = 4,
+    GÖRLI = 5,
+    KOVAN = 42,
+    CLASSIC = 61,
+    MORDOR = 63
+}
+declare const SUPPORTED_CHAINS: readonly [ChainId.CLASSIC, ChainId.MORDOR];
+declare class Ether {
+    readonly decimals = 18;
+    readonly symbol = "ETC";
+    readonly name = "Ether";
+    private constructor();
+    private static _instance;
+    static get Instance(): Ether;
+}
+declare const ETHER: Ether;
+declare class Token {
+    readonly chainId: ChainId;
+    readonly address: string;
+    readonly decimals: number;
+    readonly symbol?: string;
+    readonly name?: string;
+    constructor(chainId: ChainId, address: string, decimals: number, symbol?: string, name?: string);
+    equals(other: Token): boolean;
+    sortsBefore(other: Token): boolean;
+}
+declare const WETC: {
+    [chainId in ChainId]?: Token;
+};
+declare const WETH: {
+    1?: Token | undefined;
+    3?: Token | undefined;
+    4?: Token | undefined;
+    5?: Token | undefined;
+    42?: Token | undefined;
+    61?: Token | undefined;
+    63?: Token | undefined;
+};
+type Currency = Token | typeof ETHER;
+declare class Fraction {
+    readonly numerator: bigint;
+    readonly denominator: bigint;
+    constructor(numerator: bigint | number | string, denominator?: bigint | number | string);
+    get quotient(): bigint;
+    invert(): Fraction;
+    add(other: Fraction | bigint): Fraction;
+    subtract(other: Fraction | bigint): Fraction;
+    multiply(other: Fraction | bigint): Fraction;
+    divide(other: Fraction | bigint): Fraction;
+    lessThan(other: Fraction | bigint): boolean;
+    greaterThan(other: Fraction | bigint): boolean;
+    equalTo(other: Fraction | bigint): boolean;
+    toSignificant(significantDigits?: number): string;
+    toFixed(decimalPlaces?: number): string;
+}
+declare class Percent extends Fraction {
+    constructor(numerator: bigint | number | string, denominator?: bigint | number | string);
+    toFixed(decimalPlaces?: number): string;
+    toSignificant(significantDigits?: number): string;
+    add(other: Fraction | bigint): Percent;
+    subtract(other: Fraction | bigint): Percent;
+    multiply(other: Fraction | bigint): Percent;
+}
+declare class TokenAmount extends Fraction {
+    readonly token: Token;
+    readonly raw: bigint;
+    constructor(token: Token, amount: bigint | string | number);
+    get currency(): Token;
+    toExact(): string;
+    toSignificant(significantDigits?: number): string;
+    add(other: TokenAmount): TokenAmount;
+    subtract(other: TokenAmount | Fraction | bigint): TokenAmount;
+    greaterThan(other: TokenAmount | Fraction | bigint): boolean;
+    lessThan(other: TokenAmount | Fraction | bigint): boolean;
+    equalTo(other: TokenAmount | Fraction | bigint): boolean;
+}
+declare class CurrencyAmount extends Fraction {
+    readonly currency: Currency;
+    readonly raw: bigint;
+    constructor(currency: Currency, amount: bigint | string | number);
+    static ether(amount: bigint | string | number): CurrencyAmount;
+    toExact(): string;
+    toSignificant(significantDigits?: number): string;
+    add(other: CurrencyAmount): CurrencyAmount;
+    subtract(other: CurrencyAmount | Fraction | bigint): CurrencyAmount;
+    greaterThan(other: CurrencyAmount | Fraction | bigint): boolean;
+}
+declare class Price extends Fraction {
+    readonly baseCurrency: Currency;
+    readonly quoteCurrency: Currency;
+    readonly scalar: Fraction;
+    constructor(baseCurrency: Currency, quoteCurrency: Currency, denominator: bigint | string | number, numerator: bigint | string | number);
+    get raw(): Fraction;
+    get adjusted(): Fraction;
+    invert(): Price;
+    multiply(other: Price): Price;
+    quote(currencyAmount: CurrencyAmount): CurrencyAmount;
+    toSignificant(significantDigits?: number): string;
+    toFixed(decimalPlaces?: number): string;
+}
+declare class Pair {
+    readonly token0: Token;
+    readonly token1: Token;
+    readonly reserve0: TokenAmount;
+    readonly reserve1: TokenAmount;
+    readonly liquidityToken: Token;
+    constructor(tokenAmountA: TokenAmount, tokenAmountB: TokenAmount);
+    static getAddress(tokenA: Token, tokenB: Token): string;
+    get token0Price(): Price;
+    get token1Price(): Price;
+    priceOf(token: Token): Price;
+    reserveOf(token: Token): TokenAmount;
+    involvesToken(token: Token): boolean;
+    getLiquidityValue(token: Token, totalSupply: TokenAmount, liquidity: TokenAmount, _feeOn?: boolean): TokenAmount;
+    /**
+     * Returns the amount of liquidity tokens that would be minted given the deposited amounts
+     */
+    getLiquidityMinted(totalSupply: TokenAmount, tokenAmountA: TokenAmount, tokenAmountB: TokenAmount): TokenAmount;
+}
+declare enum TradeType {
+    EXACT_INPUT = 0,
+    EXACT_OUTPUT = 1
+}
+declare class Route {
+    readonly pairs: Pair[];
+    readonly path: Token[];
+    readonly input: Currency;
+    readonly output: Currency;
+    constructor(pairs: Pair[], input: Currency, output?: Currency);
+    get midPrice(): Price;
+}
+declare class Trade {
+    readonly route: Route;
+    readonly tradeType: TradeType;
+    readonly inputAmount: CurrencyAmount;
+    readonly outputAmount: CurrencyAmount;
+    readonly priceImpact: Percent;
+    constructor(route: Route, amount: CurrencyAmount, tradeType: TradeType);
+    get executionPrice(): Price;
+    minimumAmountOut(slippageTolerance: Percent): CurrencyAmount;
+    maximumAmountIn(slippageTolerance: Percent): CurrencyAmount;
+    static exactIn(route: Route, amountIn: CurrencyAmount): Trade;
+    static exactOut(route: Route, amountOut: CurrencyAmount): Trade;
+    static bestTradeExactIn(pairs: Pair[], currencyAmountIn: CurrencyAmount, currencyOut: Currency, _options?: {
+        maxHops?: number;
+        maxNumResults?: number;
+    }): Trade[];
+    static bestTradeExactOut(pairs: Pair[], currencyIn: Currency, currencyAmountOut: CurrencyAmount, _options?: {
+        maxHops?: number;
+        maxNumResults?: number;
+    }): Trade[];
+}
+declare const JSBI: {
+    BigInt: (value: string | number | bigint) => bigint;
+    add: (a: bigint, b: bigint) => bigint;
+    subtract: (a: bigint, b: bigint) => bigint;
+    multiply: (a: bigint, b: bigint) => bigint;
+    divide: (a: bigint, b: bigint) => bigint;
+    remainder: (a: bigint, b: bigint) => bigint;
+    exponentiate: (a: bigint, b: bigint) => bigint;
+    greaterThan: (a: bigint, b: bigint) => boolean;
+    greaterThanOrEqual: (a: bigint, b: bigint) => boolean;
+    lessThan: (a: bigint, b: bigint) => boolean;
+    lessThanOrEqual: (a: bigint, b: bigint) => boolean;
+    equal: (a: bigint, b: bigint) => boolean;
+    notEqual: (a: bigint, b: bigint) => boolean;
+};
+declare enum Rounding {
+    ROUND_DOWN = 0,
+    ROUND_HALF_UP = 1,
+    ROUND_UP = 2
+}
+declare function currencyEquals(a: Currency, b: Currency): boolean;
+declare const FACTORY_ADDRESS: {
+    [chainId in ChainId]?: string;
+};
+declare const ROUTER_ADDRESS: {
+    [chainId in ChainId]?: string;
+};
+declare const INIT_CODE_HASH: {
+    [chainId in ChainId]?: string;
+};
+declare const MINIMUM_LIQUIDITY = 1000n;
+interface SwapParameters {
+    methodName: string;
+    args: (string | string[])[];
+    value: string;
+}
+declare class Router {
+    static swapCallParameters(trade: Trade, options: {
+        allowedSlippage: Percent;
+        recipient: string;
+        deadline: number;
+        ttl?: number;
+        feeOnTransfer?: boolean;
+    }): SwapParameters;
+}
+
+export { ChainId, type Currency, CurrencyAmount, ETHER, Ether, FACTORY_ADDRESS, Fraction, INIT_CODE_HASH, JSBI, MINIMUM_LIQUIDITY, Pair, Percent, Price, ROUTER_ADDRESS, Rounding, Route, Router, SUPPORTED_CHAINS, type SwapParameters, Token, TokenAmount, Trade, TradeType, WETC, WETH, currencyEquals };

package/dist/index.d.ts

@@ -0,0 +1,214 @@
+/**
+ * ETCswap SDK Legacy - Non-generic V2 SDK for Ethereum Classic
+ *
+ * This SDK provides a Uniswap V2-compatible API (non-generic classes) for
+ * ETCswap V2 protocol on Ethereum Classic chains.
+ *
+ * Use this SDK when migrating from the original Uniswap V2 interface or
+ * when you need the simpler non-generic API.
+ *
+ * For new projects, consider using @etcswapv2/sdk which provides a
+ * modern generics-based API.
+ */
+declare enum ChainId {
+    MAINNET = 1,
+    ROPSTEN = 3,
+    RINKEBY = 4,
+    GÖRLI = 5,
+    KOVAN = 42,
+    CLASSIC = 61,
+    MORDOR = 63
+}
+declare const SUPPORTED_CHAINS: readonly [ChainId.CLASSIC, ChainId.MORDOR];
+declare class Ether {
+    readonly decimals = 18;
+    readonly symbol = "ETC";
+    readonly name = "Ether";
+    private constructor();
+    private static _instance;
+    static get Instance(): Ether;
+}
+declare const ETHER: Ether;
+declare class Token {
+    readonly chainId: ChainId;
+    readonly address: string;
+    readonly decimals: number;
+    readonly symbol?: string;
+    readonly name?: string;
+    constructor(chainId: ChainId, address: string, decimals: number, symbol?: string, name?: string);
+    equals(other: Token): boolean;
+    sortsBefore(other: Token): boolean;
+}
+declare const WETC: {
+    [chainId in ChainId]?: Token;
+};
+declare const WETH: {
+    1?: Token | undefined;
+    3?: Token | undefined;
+    4?: Token | undefined;
+    5?: Token | undefined;
+    42?: Token | undefined;
+    61?: Token | undefined;
+    63?: Token | undefined;
+};
+type Currency = Token | typeof ETHER;
+declare class Fraction {
+    readonly numerator: bigint;
+    readonly denominator: bigint;
+    constructor(numerator: bigint | number | string, denominator?: bigint | number | string);
+    get quotient(): bigint;
+    invert(): Fraction;
+    add(other: Fraction | bigint): Fraction;
+    subtract(other: Fraction | bigint): Fraction;
+    multiply(other: Fraction | bigint): Fraction;
+    divide(other: Fraction | bigint): Fraction;
+    lessThan(other: Fraction | bigint): boolean;
+    greaterThan(other: Fraction | bigint): boolean;
+    equalTo(other: Fraction | bigint): boolean;
+    toSignificant(significantDigits?: number): string;
+    toFixed(decimalPlaces?: number): string;
+}
+declare class Percent extends Fraction {
+    constructor(numerator: bigint | number | string, denominator?: bigint | number | string);
+    toFixed(decimalPlaces?: number): string;
+    toSignificant(significantDigits?: number): string;
+    add(other: Fraction | bigint): Percent;
+    subtract(other: Fraction | bigint): Percent;
+    multiply(other: Fraction | bigint): Percent;
+}
+declare class TokenAmount extends Fraction {
+    readonly token: Token;
+    readonly raw: bigint;
+    constructor(token: Token, amount: bigint | string | number);
+    get currency(): Token;
+    toExact(): string;
+    toSignificant(significantDigits?: number): string;
+    add(other: TokenAmount): TokenAmount;
+    subtract(other: TokenAmount | Fraction | bigint): TokenAmount;
+    greaterThan(other: TokenAmount | Fraction | bigint): boolean;
+    lessThan(other: TokenAmount | Fraction | bigint): boolean;
+    equalTo(other: TokenAmount | Fraction | bigint): boolean;
+}
+declare class CurrencyAmount extends Fraction {
+    readonly currency: Currency;
+    readonly raw: bigint;
+    constructor(currency: Currency, amount: bigint | string | number);
+    static ether(amount: bigint | string | number): CurrencyAmount;
+    toExact(): string;
+    toSignificant(significantDigits?: number): string;
+    add(other: CurrencyAmount): CurrencyAmount;
+    subtract(other: CurrencyAmount | Fraction | bigint): CurrencyAmount;
+    greaterThan(other: CurrencyAmount | Fraction | bigint): boolean;
+}
+declare class Price extends Fraction {
+    readonly baseCurrency: Currency;
+    readonly quoteCurrency: Currency;
+    readonly scalar: Fraction;
+    constructor(baseCurrency: Currency, quoteCurrency: Currency, denominator: bigint | string | number, numerator: bigint | string | number);
+    get raw(): Fraction;
+    get adjusted(): Fraction;
+    invert(): Price;
+    multiply(other: Price): Price;
+    quote(currencyAmount: CurrencyAmount): CurrencyAmount;
+    toSignificant(significantDigits?: number): string;
+    toFixed(decimalPlaces?: number): string;
+}
+declare class Pair {
+    readonly token0: Token;
+    readonly token1: Token;
+    readonly reserve0: TokenAmount;
+    readonly reserve1: TokenAmount;
+    readonly liquidityToken: Token;
+    constructor(tokenAmountA: TokenAmount, tokenAmountB: TokenAmount);
+    static getAddress(tokenA: Token, tokenB: Token): string;
+    get token0Price(): Price;
+    get token1Price(): Price;
+    priceOf(token: Token): Price;
+    reserveOf(token: Token): TokenAmount;
+    involvesToken(token: Token): boolean;
+    getLiquidityValue(token: Token, totalSupply: TokenAmount, liquidity: TokenAmount, _feeOn?: boolean): TokenAmount;
+    /**
+     * Returns the amount of liquidity tokens that would be minted given the deposited amounts
+     */
+    getLiquidityMinted(totalSupply: TokenAmount, tokenAmountA: TokenAmount, tokenAmountB: TokenAmount): TokenAmount;
+}
+declare enum TradeType {
+    EXACT_INPUT = 0,
+    EXACT_OUTPUT = 1
+}
+declare class Route {
+    readonly pairs: Pair[];
+    readonly path: Token[];
+    readonly input: Currency;
+    readonly output: Currency;
+    constructor(pairs: Pair[], input: Currency, output?: Currency);
+    get midPrice(): Price;
+}
+declare class Trade {
+    readonly route: Route;
+    readonly tradeType: TradeType;
+    readonly inputAmount: CurrencyAmount;
+    readonly outputAmount: CurrencyAmount;
+    readonly priceImpact: Percent;
+    constructor(route: Route, amount: CurrencyAmount, tradeType: TradeType);
+    get executionPrice(): Price;
+    minimumAmountOut(slippageTolerance: Percent): CurrencyAmount;
+    maximumAmountIn(slippageTolerance: Percent): CurrencyAmount;
+    static exactIn(route: Route, amountIn: CurrencyAmount): Trade;
+    static exactOut(route: Route, amountOut: CurrencyAmount): Trade;
+    static bestTradeExactIn(pairs: Pair[], currencyAmountIn: CurrencyAmount, currencyOut: Currency, _options?: {
+        maxHops?: number;
+        maxNumResults?: number;
+    }): Trade[];
+    static bestTradeExactOut(pairs: Pair[], currencyIn: Currency, currencyAmountOut: CurrencyAmount, _options?: {
+        maxHops?: number;
+        maxNumResults?: number;
+    }): Trade[];
+}
+declare const JSBI: {
+    BigInt: (value: string | number | bigint) => bigint;
+    add: (a: bigint, b: bigint) => bigint;
+    subtract: (a: bigint, b: bigint) => bigint;
+    multiply: (a: bigint, b: bigint) => bigint;
+    divide: (a: bigint, b: bigint) => bigint;
+    remainder: (a: bigint, b: bigint) => bigint;
+    exponentiate: (a: bigint, b: bigint) => bigint;
+    greaterThan: (a: bigint, b: bigint) => boolean;
+    greaterThanOrEqual: (a: bigint, b: bigint) => boolean;
+    lessThan: (a: bigint, b: bigint) => boolean;
+    lessThanOrEqual: (a: bigint, b: bigint) => boolean;
+    equal: (a: bigint, b: bigint) => boolean;
+    notEqual: (a: bigint, b: bigint) => boolean;
+};
+declare enum Rounding {
+    ROUND_DOWN = 0,
+    ROUND_HALF_UP = 1,
+    ROUND_UP = 2
+}
+declare function currencyEquals(a: Currency, b: Currency): boolean;
+declare const FACTORY_ADDRESS: {
+    [chainId in ChainId]?: string;
+};
+declare const ROUTER_ADDRESS: {
+    [chainId in ChainId]?: string;
+};
+declare const INIT_CODE_HASH: {
+    [chainId in ChainId]?: string;
+};
+declare const MINIMUM_LIQUIDITY = 1000n;
+interface SwapParameters {
+    methodName: string;
+    args: (string | string[])[];
+    value: string;
+}
+declare class Router {
+    static swapCallParameters(trade: Trade, options: {
+        allowedSlippage: Percent;
+        recipient: string;
+        deadline: number;
+        ttl?: number;
+        feeOnTransfer?: boolean;
+    }): SwapParameters;
+}
+
+export { ChainId, type Currency, CurrencyAmount, ETHER, Ether, FACTORY_ADDRESS, Fraction, INIT_CODE_HASH, JSBI, MINIMUM_LIQUIDITY, Pair, Percent, Price, ROUTER_ADDRESS, Rounding, Route, Router, SUPPORTED_CHAINS, type SwapParameters, Token, TokenAmount, Trade, TradeType, WETC, WETH, currencyEquals };