@swapkit/helpers 1.0.0-rc.70 → 1.0.0-rc.72

package/dist/index.d.ts

@@ -1,3 +1,4 @@
+import { BaseDecimal } from '@swapkit/types';
 import { Chain } from '@swapkit/types';
 import type { ChainflipList } from '@swapkit/tokens';
 import { ChainId } from '@swapkit/types';
@@ -15,7 +16,7 @@ import type { TraderjoeList } from '@swapkit/tokens';
 import type { UniswapList } from '@swapkit/tokens';
 import type { WoofiList } from '@swapkit/tokens';
 
-declare type AllowedNumberTypes = 'bigint' | 'number' | 'string';
+declare type AllowedNumberTypes = "bigint" | "number" | "string";
 
 export declare const assetFromString: (assetString: string) => {
     chain: Chain;
@@ -57,6 +58,8 @@ export declare class AssetValue extends BigIntArithmetics {
     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<{
@@ -144,6 +147,7 @@ declare const errorMessages: {
     readonly core_swap_contract_not_supported: 10205;
     readonly core_swap_transaction_error: 10206;
     readonly core_swap_quote_mode_not_supported: 10207;
+    readonly core_swap_provider_not_found: 10208;
     /**
      * Core - Transaction
      */
@@ -170,6 +174,13 @@ declare const errorMessages: {
     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;
+    /**
+     * THORChain
+     */
     /**
      * Helpers
      */
@@ -238,7 +249,7 @@ export declare const getCommonAssetInfo: (assetString: CommonAssetString) => {
 export declare const getDecimal: ({ chain, symbol }: {
     chain: Chain;
     symbol: string;
-}) => Promise<number>;
+}) => BaseDecimal | Promise<number>;
 
 export declare function getEstimatedPoolShare({ runeDepth, poolUnits, assetDepth, liquidityUnits, runeAmount, assetAmount, }: ShareParams<{
     runeAmount: string;
@@ -279,19 +290,26 @@ export declare const isGasAsset: ({ chain, symbol }: {
 }) => boolean;
 
 export declare type MemoOptions<T extends MemoType> = {
-    [MemoType.BOND]: WithAddress;
-    [MemoType.LEAVE]: WithAddress;
-    [MemoType.CLOSE_LOAN]: WithAddress<{
+    [MemoType.BOND]: {
+        address: string;
+    };
+    [MemoType.LEAVE]: {
+        address: string;
+    };
+    [MemoType.CLOSE_LOAN]: {
+        address: string;
         asset: string;
         minAmount?: string;
-    }>;
-    [MemoType.OPEN_LOAN]: WithAddress<{
+    };
+    [MemoType.OPEN_LOAN]: {
+        address: string;
         asset: string;
         minAmount?: string;
-    }>;
-    [MemoType.UNBOND]: WithAddress<{
+    };
+    [MemoType.UNBOND]: {
+        address: string;
         unbondAmount: number;
-    }>;
+    };
     [MemoType.DEPOSIT]: WithChain<{
         symbol: string;
         address?: string;
@@ -304,7 +322,7 @@ export declare type MemoOptions<T extends MemoType> = {
         targetAssetString?: string;
         singleSide?: boolean;
     }>;
-    [MemoType.THORNAME_REGISTER]: Omit<ThornameRegisterParam, 'preferredAsset' | 'expiryBlock'>;
+    [MemoType.THORNAME_REGISTER]: Omit<ThornameRegisterParam, "preferredAsset" | "expiryBlock">;
 }[T];
 
 export declare type NumberPrimitives = bigint | number | string;
@@ -315,14 +333,14 @@ declare type NumberPrimitivesType = {
     string: string;
 };
 
-declare type PoolParams<T = {}> = T & {
+declare type PoolParams = {
     runeAmount: string;
     assetAmount: string;
     runeDepth: string;
     assetDepth: string;
 };
 
-declare type ShareParams<T = {}> = T & {
+declare type ShareParams<T extends {}> = T & {
     liquidityUnits: string;
     poolUnits: string;
 };
@@ -352,7 +370,7 @@ export declare type ThornameRegisterParam = {
     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 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;
@@ -361,11 +379,7 @@ declare type TokenTax = {
 
 export declare function validateTHORName(name: string): boolean;
 
-declare type WithAddress<T = {}> = T & {
-    address: string;
-};
-
-declare type WithChain<T = {}> = T & {
+declare type WithChain<T extends {}> = T & {
     chain: Chain;
 };