@swapkit/helpers 1.0.0-rc.51 → 1.0.0-rc.53

package/dist/index.d.ts

@@ -32,7 +32,19 @@ export declare class AssetValue extends BigIntArithmetics {
     tax?: TokenTax;
     ticker: string;
     type: ReturnType<typeof getAssetType>;
-    constructor(params: AssetValueParams);
+    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 }: {
@@ -41,9 +53,9 @@ export declare class AssetValue extends BigIntArithmetics {
     }): boolean;
     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 | undefined;
-    static fromIdentifier(assetString: `${Chain}.${string}` | `${Chain}/${string}` | `${Chain}.${string}-${string}`, value?: NumberPrimitives): Promise<AssetValue>;
-    static fromIdentifierSync(identifier: TokenNames, value?: NumberPrimitives): AssetValue;
+    static fromIdentifierSync(assetString: TokenNames, value?: NumberPrimitives): AssetValue | undefined;
     static fromChainOrSignature(assetString: CommonAssetString, value?: NumberPrimitives): AssetValue;
     static loadStaticAssets(): Promise<{
         ok: true;
@@ -54,17 +66,6 @@ export declare class AssetValue extends BigIntArithmetics {
     }>;
 }
 
-declare type AssetValueParams = {
-    decimal: number;
-    value: SwapKitValueType;
-    tax?: TokenTax;
-} & ({
-    chain: Chain;
-    symbol: string;
-} | {
-    identifier: string;
-});
-
 export declare class BigIntArithmetics {
 
     decimalMultiplier: bigint;
@@ -104,7 +105,7 @@ export declare class BigIntArithmetics {
 
 export declare type CommonAssetString = 'MAYA.MAYA' | 'ETH.THOR' | 'ETH.vTHOR' | Chain;
 
-export declare const derivationPathToString: ([network, chainId, account, change, index]: number[]) => string;
+export declare function derivationPathToString([network, chainId, account, change, index]: number[]): string;
 
 declare const errorMessages: {
     /**
@@ -190,14 +191,14 @@ export declare const getAssetType: ({ chain, symbol }: {
     symbol: string;
 }) => Chain.Avalanche | Chain.Cosmos | Chain.Kujira | "Synth" | "Native" | "BEP2" | "BEP20" | "ERC20" | "POLYGON" | "ARBITRUM" | "OPTIMISM";
 
-export declare const getAsymmetricAssetShare: ({ liquidityUnits, poolUnits, assetDepth, }: ShareParams<{
+export declare function getAsymmetricAssetShare({ liquidityUnits, poolUnits, assetDepth, }: ShareParams<{
     assetDepth: string;
-}>) => SwapKitNumber;
+}>): SwapKitNumber;
 
-export declare const getAsymmetricAssetWithdrawAmount: ({ percent, assetDepth, liquidityUnits, poolUnits, }: ShareParams<{
+export declare function getAsymmetricAssetWithdrawAmount({ percent, assetDepth, liquidityUnits, poolUnits, }: ShareParams<{
     percent: number;
     assetDepth: string;
-}>) => SwapKitNumber;
+}>): SwapKitNumber;
 
 /**
  *  Ref: https://gitlab.com/thorchain/thornode/-/issues/657
@@ -210,14 +211,14 @@ export declare const getAsymmetricAssetWithdrawAmount: ({ percent, assetDepth, l
  *  share = (s * A * (2 * T^2 - 2 * T * s + s^2))/T^3
  *  (part1 * (part2 - part3 + part4)) / part5
  */
-export declare const getAsymmetricRuneShare: ({ liquidityUnits, poolUnits, runeDepth, }: ShareParams<{
+export declare function getAsymmetricRuneShare({ liquidityUnits, poolUnits, runeDepth, }: ShareParams<{
     runeDepth: string;
-}>) => SwapKitNumber;
+}>): SwapKitNumber;
 
-export declare const getAsymmetricRuneWithdrawAmount: ({ percent, runeDepth, liquidityUnits, poolUnits, }: ShareParams<{
+export declare function getAsymmetricRuneWithdrawAmount({ percent, runeDepth, liquidityUnits, poolUnits, }: ShareParams<{
     percent: number;
     runeDepth: string;
-}>) => SwapKitNumber;
+}>): SwapKitNumber;
 
 export declare const getCommonAssetInfo: (assetString: CommonAssetString) => {
     identifier: string;
@@ -229,36 +230,36 @@ export declare const getDecimal: ({ chain, symbol }: {
     symbol: string;
 }) => Promise<number>;
 
-export declare const getEstimatedPoolShare: ({ runeDepth, poolUnits, assetDepth, liquidityUnits, runeAmount, assetAmount, }: ShareParams<{
+export declare function getEstimatedPoolShare({ runeDepth, poolUnits, assetDepth, liquidityUnits, runeAmount, assetAmount, }: ShareParams<{
     runeAmount: string;
     assetAmount: string;
     runeDepth: string;
     assetDepth: string;
-}>) => number;
+}>): number;
 
-export declare const getLiquiditySlippage: ({ runeAmount, assetAmount, runeDepth, assetDepth, }: PoolParams) => number;
+export declare function getLiquiditySlippage({ runeAmount, assetAmount, runeDepth, assetDepth, }: PoolParams): number;
 
 export declare const getMemoFor: <T extends MemoType>(memoType: T, options: MemoOptions<T>) => string;
 
-export declare const getMinAmountByChain: (chain: Chain) => AssetValue;
+export declare function getMinAmountByChain(chain: Chain): AssetValue;
 
-export declare const getSymmetricPoolShare: ({ liquidityUnits, poolUnits, runeDepth, assetDepth, }: ShareParams<{
+export declare function getSymmetricPoolShare({ liquidityUnits, poolUnits, runeDepth, assetDepth, }: ShareParams<{
     runeDepth: string;
     assetDepth: string;
-}>) => {
+}>): {
     assetAmount: SwapKitNumber;
     runeAmount: SwapKitNumber;
 };
 
-export declare const getSymmetricWithdraw: ({ liquidityUnits, poolUnits, runeDepth, assetDepth, percent, }: ShareParams<{
+export declare function getSymmetricWithdraw({ liquidityUnits, poolUnits, runeDepth, assetDepth, percent, }: ShareParams<{
     runeDepth: string;
     assetDepth: string;
     percent: number;
-}>) => {
+}>): {
     [k: string]: SwapKitNumber;
 };
 
-export declare const getTHORNameCost: (year: number) => number;
+export declare function getTHORNameCost(year: number): number;
 
 declare type InitialisationValueType = NumberPrimitives | BigIntArithmetics | SwapKitNumber;
 
@@ -339,8 +340,6 @@ export declare class SwapKitNumber extends BigIntArithmetics {
 
 export declare type SwapKitValueType = BigIntArithmetics | string | number;
 
-declare type TCTokenNames = (typeof ThorchainList)['tokens'][number]['identifier'];
-
 export declare type ThornameRegisterParam = {
     name: string;
     chain: string;
@@ -350,14 +349,14 @@ export declare type ThornameRegisterParam = {
     expiryBlock?: string;
 };
 
-declare type TokenNames = TCTokenNames | (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'];
+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'];
 
 declare type TokenTax = {
     buy: number;
     sell: number;
 };
 
-export declare const validateTHORName: (name: string) => boolean;
+export declare function validateTHORName(name: string): boolean;
 
 declare type WithAddress<T = {}> = T & {
     address: string;