@swapkit/helpers 1.0.0-rc.83 → 1.0.0-rc.85

package/dist/index.d.ts

@@ -1,408 +0,0 @@
-import { BaseDecimal } from '@swapkit/types';
-import { Chain } from '@swapkit/types';
-import type { ChainflipList } from '@swapkit/tokens';
-import { ChainId } from '@swapkit/types';
-import type { CoinGeckoList } from '@swapkit/tokens';
-import type { EVMChain } from '@swapkit/types';
-import { FeeOption } from '@swapkit/types';
-import type { MayaList } from '@swapkit/tokens';
-import { MemoType } from '@swapkit/types';
-import type { PancakeswapETHList } from '@swapkit/tokens';
-import type { PancakeswapList } from '@swapkit/tokens';
-import type { PangolinList } from '@swapkit/tokens';
-import type { StargateARBList } from '@swapkit/tokens';
-import type { SushiswapList } from '@swapkit/tokens';
-import type { ThorchainList } from '@swapkit/tokens';
-import type { TraderjoeList } from '@swapkit/tokens';
-import type { UniswapList } from '@swapkit/tokens';
-import type { WoofiList } from '@swapkit/tokens';
-
-declare type AllowedNumberTypes = "bigint" | "number" | "string";
-
-export declare const assetFromString: (assetString: string) => {
-    chain: Chain;
-    symbol: string;
-    ticker: string;
-    synth: boolean;
-};
-
-export declare class AssetValue extends BigIntArithmetics {
-    address?: string;
-    chain: Chain;
-    isGasAsset: boolean;
-    isSynthetic: boolean;
-    symbol: string;
-    tax?: TokenTax;
-    ticker: string;
-    type: ReturnType<typeof getAssetType>;
-    constructor({ value, decimal, tax, chain, symbol, identifier, }: {
-        decimal: number;
-        value: SwapKitValueType;
-        tax?: TokenTax;
-    } & ({
-        chain: Chain;
-        symbol: string;
-        identifier?: never;
-    } | {
-        identifier: string;
-        chain?: never;
-        symbol?: never;
-    }));
-    toString(): string;
-    toUrl(): string;
-    eq({ chain, symbol }: {
-        chain: Chain;
-        symbol: string;
-    }): boolean;
-    chainId(): ChainId;
-    static fromUrl(urlAsset: string, value?: NumberPrimitives): Promise<AssetValue>;
-    static fromString(assetString: string, value?: NumberPrimitives): Promise<AssetValue>;
-    static fromIdentifier(assetString: `${Chain}.${string}` | `${Chain}/${string}` | `${Chain}.${string}-${string}` | TokenNames, value?: NumberPrimitives): Promise<AssetValue>;
-    static fromStringSync(assetString: string, value?: NumberPrimitives): AssetValue;
-    static fromStringWithBase(assetString: string, value?: NumberPrimitives, baseDecimal?: number): Promise<AssetValue>;
-    static fromStringWithBaseSync(assetString: string, value?: NumberPrimitives, baseDecimal?: number): AssetValue;
-    static fromIdentifierSync(assetString: TokenNames, value?: NumberPrimitives): AssetValue;
-    static fromChainOrSignature(assetString: CommonAssetString, value?: NumberPrimitives): AssetValue;
-    static loadStaticAssets(): Promise<{
-        ok: true;
-    } | {
-        ok: false;
-        message: string;
-        error: any;
-    }>;
-}
-
-export declare class BigIntArithmetics {
-
-    decimalMultiplier: bigint;
-    bigIntValue: bigint;
-    decimal?: number;
-    static fromBigInt(value: bigint, decimal?: number): BigIntArithmetics;
-    static shiftDecimals({ value, from, to, }: {
-        value: InstanceType<typeof SwapKitNumber>;
-        from: number;
-        to: number;
-    }): BigIntArithmetics;
-    constructor(params: SKBigIntParams);
-    set(value: SKBigIntParams): this;
-    add(...args: InitialisationValueType[]): this;
-    sub(...args: InitialisationValueType[]): this;
-    mul(...args: InitialisationValueType[]): this;
-    div(...args: InitialisationValueType[]): this;
-    gt(value: InitialisationValueType): boolean;
-    gte(value: InitialisationValueType): boolean;
-    lt(value: InitialisationValueType): boolean;
-    lte(value: InitialisationValueType): boolean;
-    eqValue(value: InitialisationValueType): boolean;
-    getValue<T extends AllowedNumberTypes>(type: T): NumberPrimitivesType[T];
-    getBaseValue<T extends AllowedNumberTypes>(type: T): NumberPrimitivesType[T];
-    getBigIntValue(value: InitialisationValueType, decimal?: number): bigint;
-    toSignificant(significantDigits?: number): string;
-    toFixed(fixedDigits?: number): string;
-    toAbbreviation(digits?: number): string;
-    toCurrency(currency?: string, { currencyPosition, decimal, decimalSeparator, thousandSeparator, }?: {
-        currencyPosition?: string | undefined;
-        decimal?: number | undefined;
-        decimalSeparator?: string | undefined;
-        thousandSeparator?: string | undefined;
-    }): string;
-    formatBigIntToSafeValue(value: bigint, decimal?: number): string;
-}
-
-export declare type CommonAssetString = `${Chain.Maya}.MAYA` | `${Chain.Ethereum}.THOR` | `${Chain.Ethereum}.vTHOR` | `${Chain.Kujira}.USK` | Chain;
-
-export declare function derivationPathToString([network, chainId, account, change, index]: [
-number,
-number,
-number,
-number,
-number | undefined
-]): string;
-
-export declare type ErrorKeys = keyof typeof errorMessages;
-
-declare const errorMessages: {
-    /**
-     * Core
-     */
-    readonly core_wallet_connection_not_found: 10001;
-    readonly core_estimated_max_spendable_chain_not_supported: 10002;
-    readonly core_extend_error: 10003;
-    readonly core_inbound_data_not_found: 10004;
-    readonly core_approve_asset_address_or_from_not_found: 10005;
-    readonly core_plugin_not_found: 10006;
-    readonly core_chain_halted: 10099;
-    /**
-     * Core - Wallet Connection
-     */
-    readonly core_wallet_xdefi_not_installed: 10101;
-    readonly core_wallet_evmwallet_not_installed: 10102;
-    readonly core_wallet_walletconnect_not_installed: 10103;
-    readonly core_wallet_keystore_not_installed: 10104;
-    readonly core_wallet_ledger_not_installed: 10105;
-    readonly core_wallet_trezor_not_installed: 10106;
-    readonly core_wallet_keplr_not_installed: 10107;
-    readonly core_wallet_okx_not_installed: 10108;
-    readonly core_wallet_keepkey_not_installed: 10109;
-    /**
-     * Core - Swap
-     */
-    readonly core_swap_invalid_params: 10200;
-    readonly core_swap_route_not_complete: 10201;
-    readonly core_swap_asset_not_recognized: 10202;
-    readonly core_swap_contract_not_found: 10203;
-    readonly core_swap_route_transaction_not_found: 10204;
-    readonly core_swap_contract_not_supported: 10205;
-    readonly core_swap_transaction_error: 10206;
-    readonly core_swap_quote_mode_not_supported: 10207;
-    /**
-     * Core - Transaction
-     */
-    readonly core_transaction_deposit_error: 10301;
-    readonly core_transaction_create_liquidity_rune_error: 10302;
-    readonly core_transaction_create_liquidity_asset_error: 10303;
-    readonly core_transaction_create_liquidity_invalid_params: 10304;
-    readonly core_transaction_add_liquidity_invalid_params: 10305;
-    readonly core_transaction_add_liquidity_no_rune_address: 10306;
-    readonly core_transaction_add_liquidity_rune_error: 10307;
-    readonly core_transaction_add_liquidity_asset_error: 10308;
-    readonly core_transaction_withdraw_error: 10309;
-    readonly core_transaction_deposit_to_pool_error: 10310;
-    readonly core_transaction_deposit_insufficient_funds_error: 10311;
-    readonly core_transaction_deposit_gas_error: 10312;
-    readonly core_transaction_invalid_sender_address: 10313;
-    readonly core_transaction_deposit_server_error: 10314;
-    readonly core_transaction_user_rejected: 10315;
-    /**
-     * Wallets
-     */
-    readonly wallet_ledger_connection_error: 20001;
-    readonly wallet_ledger_connection_claimed: 20002;
-    readonly wallet_ledger_get_address_error: 20003;
-    readonly wallet_ledger_device_not_found: 20004;
-    readonly wallet_ledger_device_locked: 20005;
-    /**
-     * Chainflip
-     */
-    readonly chainflip_channel_error: 30001;
-    readonly chainflip_broker_recipient_error: 30002;
-    /**
-     * THORChain
-     */
-    /**
-     * Helpers
-     */
-    readonly helpers_number_different_decimals: 99101;
-};
-
-export declare const filterAssets: (tokens: {
-    value: string;
-    decimal: number;
-    chain: Chain;
-    symbol: string;
-}[]) => {
-    value: string;
-    decimal: number;
-    chain: Chain;
-    symbol: string;
-}[];
-
-export declare function findAssetBy(params: {
-    chain: EVMChain;
-    contract: string;
-} | {
-    identifier: `${Chain}.${string}`;
-}): Promise<TokenNames | undefined>;
-
-export declare function formatBigIntToSafeValue({ value, bigIntDecimal, decimal, }: {
-    value: bigint;
-    bigIntDecimal?: number;
-    decimal?: number;
-}): string;
-
-export declare const gasFeeMultiplier: Record<FeeOption, number>;
-
-export declare const getAssetType: ({ chain, symbol }: {
-    chain: Chain;
-    symbol: string;
-}) => Chain.Avalanche | Chain.Cosmos | Chain.Kujira | "Synth" | "Native" | "BEP2" | "BEP20" | "ERC20" | "POLYGON" | "ARBITRUM" | "OPTIMISM";
-
-export declare function getAsymmetricAssetShare({ liquidityUnits, poolUnits, assetDepth, }: ShareParams<{
-    assetDepth: string;
-}>): SwapKitNumber;
-
-export declare function getAsymmetricAssetWithdrawAmount({ percent, assetDepth, liquidityUnits, poolUnits, }: ShareParams<{
-    percent: number;
-    assetDepth: string;
-}>): SwapKitNumber;
-
-/**
- *  Ref: https://gitlab.com/thorchain/thornode/-/issues/657
- *  share = (s * A * (2 * T^2 - 2 * T * s + s^2))/T^3
- *  s = stakeUnits for member (after factoring in withdrawBasisPoints)
- *  T = totalPoolUnits for pool
- *  A = assetDepth to be withdrawn
- *
- *  Formula:
- *  share = (s * A * (2 * T^2 - 2 * T * s + s^2))/T^3
- *  (part1 * (part2 - part3 + part4)) / part5
- */
-export declare function getAsymmetricRuneShare({ liquidityUnits, poolUnits, runeDepth, }: ShareParams<{
-    runeDepth: string;
-}>): SwapKitNumber;
-
-export declare function getAsymmetricRuneWithdrawAmount({ percent, runeDepth, liquidityUnits, poolUnits, }: ShareParams<{
-    percent: number;
-    runeDepth: string;
-}>): SwapKitNumber;
-
-export declare const getCommonAssetInfo: (assetString: CommonAssetString) => {
-    identifier: string;
-    decimal: number;
-};
-
-export declare const getDecimal: ({ chain, symbol }: {
-    chain: Chain;
-    symbol: string;
-}) => BaseDecimal | Promise<number>;
-
-export declare function getEstimatedPoolShare({ runeDepth, poolUnits, assetDepth, liquidityUnits, runeAmount, assetAmount, }: ShareParams<{
-    runeAmount: string;
-    assetAmount: string;
-    runeDepth: string;
-    assetDepth: string;
-}>): number;
-
-export declare function getLiquiditySlippage({ runeAmount, assetAmount, runeDepth, assetDepth, }: PoolParams): number;
-
-export declare function getMAYANameCost(year: number): number;
-
-export declare const getMemoFor: <T extends MemoType>(memoType: T, options: MemoOptions<T>) => string;
-
-export declare function getMinAmountByChain(chain: Chain): AssetValue;
-
-export declare function getSymmetricPoolShare({ liquidityUnits, poolUnits, runeDepth, assetDepth, }: ShareParams<{
-    runeDepth: string;
-    assetDepth: string;
-}>): {
-    assetAmount: SwapKitNumber;
-    runeAmount: SwapKitNumber;
-};
-
-export declare function getSymmetricWithdraw({ liquidityUnits, poolUnits, runeDepth, assetDepth, percent, }: ShareParams<{
-    runeDepth: string;
-    assetDepth: string;
-    percent: number;
-}>): {
-    [k: string]: SwapKitNumber;
-};
-
-export declare function getTHORNameCost(year: number): number;
-
-declare type InitialisationValueType = NumberPrimitives | BigIntArithmetics | SwapKitNumber;
-
-export declare const isGasAsset: ({ chain, symbol }: {
-    chain: Chain;
-    symbol: string;
-}) => boolean;
-
-export declare type MemoOptions<T extends MemoType> = {
-    [MemoType.BOND]: {
-        address: string;
-    };
-    [MemoType.LEAVE]: {
-        address: string;
-    };
-    [MemoType.CLOSE_LOAN]: {
-        address: string;
-        asset: string;
-        minAmount?: string;
-    };
-    [MemoType.OPEN_LOAN]: {
-        address: string;
-        asset: string;
-        minAmount?: string;
-    };
-    [MemoType.UNBOND]: {
-        address: string;
-        unbondAmount: number;
-    };
-    [MemoType.DEPOSIT]: WithChain<{
-        symbol: string;
-        address?: string;
-        singleSide?: boolean;
-    }>;
-    [MemoType.WITHDRAW]: WithChain<{
-        ticker: string;
-        symbol: string;
-        basisPoints: number;
-        targetAssetString?: string;
-        singleSide?: boolean;
-    }>;
-    [MemoType.THORNAME_REGISTER]: Omit<ThornameRegisterParam, "preferredAsset" | "expiryBlock">;
-}[T];
-
-export declare type NumberPrimitives = bigint | number | string;
-
-declare type NumberPrimitivesType = {
-    bigint: bigint;
-    number: number;
-    string: string;
-};
-
-declare type PoolParams = {
-    runeAmount: string;
-    assetAmount: string;
-    runeDepth: string;
-    assetDepth: string;
-};
-
-declare type ShareParams<T extends {}> = T & {
-    liquidityUnits: string;
-    poolUnits: string;
-};
-
-declare type SKBigIntParams = InitialisationValueType | {
-    decimal?: number;
-    value: number | string;
-};
-
-export declare class SwapKitError extends Error {
-    constructor(errorKey: ErrorKeys, sourceError?: any);
-}
-
-export declare class SwapKitNumber extends BigIntArithmetics {
-    eq(value: SwapKitValueType): boolean;
-    static fromBigInt(value: bigint, decimal?: number): SwapKitNumber;
-}
-
-export declare type SwapKitValueType = BigIntArithmetics | string | number;
-
-export declare type ThornameRegisterParam = {
-    name: string;
-    chain: string;
-    address: string;
-    owner?: string;
-    preferredAsset?: string;
-    expiryBlock?: string;
-};
-
-declare type TokenNames = (typeof ThorchainList)["tokens"][number]["identifier"] | (typeof CoinGeckoList)["tokens"][number]["identifier"] | (typeof MayaList)["tokens"][number]["identifier"] | (typeof PancakeswapETHList)["tokens"][number]["identifier"] | (typeof PancakeswapList)["tokens"][number]["identifier"] | (typeof PangolinList)["tokens"][number]["identifier"] | (typeof StargateARBList)["tokens"][number]["identifier"] | (typeof SushiswapList)["tokens"][number]["identifier"] | (typeof TraderjoeList)["tokens"][number]["identifier"] | (typeof WoofiList)["tokens"][number]["identifier"] | (typeof UniswapList)["tokens"][number]["identifier"] | (typeof ChainflipList)["tokens"][number]["identifier"];
-
-declare type TokenTax = {
-    buy: number;
-    sell: number;
-};
-
-export declare function validateMAYAName(name: string): boolean;
-
-export declare function validateTHORName(name: string): boolean;
-
-declare type WithChain<T extends {}> = T & {
-    chain: Chain;
-};
-
-
-export * from "@swapkit/api";
-
-export { }