@xchainjs/xchain-aggregator 0.1.18 → 0.2.0

package/lib/protocols/chainflip/chainflipProtocol.d.ts

@@ -0,0 +1,50 @@
+import { Asset, Chain } from '@xchainjs/xchain-util';
+import { Wallet } from '@xchainjs/xchain-wallet';
+import { IProtocol, QuoteSwap, QuoteSwapParams, SwapHistory, TxSubmitted } from '../../types';
+/**
+ * Chainflip protocol
+ */
+export declare class ChainflipProtocol implements IProtocol {
+    readonly name = "Chainflip";
+    private sdk;
+    private wallet;
+    private assetsData;
+    constructor(wallet?: Wallet);
+    /**
+     * Check if an asset is supported in the protocol
+     * @param {Asset} asset Asset to check if it is supported
+     * @returns {boolean} True if the asset is supported, otherwise false
+     */
+    isAssetSupported(asset: Asset): Promise<boolean>;
+    /**
+     * Retrieve the supported chains by the protocol
+     * @returns {Chain[]} the supported chains by the protocol
+     */
+    getSupportedChains(): Promise<Chain[]>;
+    /**
+     * Estimate swap by validating the swap parameters.
+     *
+     * @param {QuoteSwapParams} quoteSwapParams Swap parameters.
+     * @returns {QuoteSwap} Quote swap result. If swap cannot be done, it returns an empty QuoteSwap with reasons.
+     */
+    estimateSwap(params: QuoteSwapParams): Promise<QuoteSwap>;
+    /**
+     * Perform a swap operation between assets.
+     * @param {QuoteSwapParams} quoteSwapParams Swap parameters
+     * @returns {TxSubmitted} Transaction hash and URL of the swap
+     */
+    doSwap(params: QuoteSwapParams): Promise<TxSubmitted>;
+    /**
+     * Get historical swaps
+     * @throws {Error} - Method not implemented.
+     * @returns the swap history
+     */
+    getSwapHistory(): Promise<SwapHistory>;
+    /**
+     * Get asset data
+     * @param {Asset} asset - Asset of which return data
+     * @throws {Error} - If asset is not supported in Chainflip
+     * @returns the asset data
+     */
+    private getAssetData;
+}

package/lib/protocols/chainflip/index.d.ts

@@ -0,0 +1 @@
+export { ChainflipProtocol } from './chainflipProtocol';

package/lib/protocols/chainflip/utils.d.ts

@@ -0,0 +1,6 @@
+import { Asset as CAsset, AssetData, Chain as CChain } from '@chainflip/sdk/swap';
+import { Asset as XAsset, Chain as XChain } from '@xchainjs/xchain-util';
+export declare const cChainToXChain: (chain: CChain) => XChain;
+export declare const xChainToCChain: (chain: XChain) => CChain;
+export declare const cAssetToXAsset: (asset: AssetData) => XAsset;
+export declare const xAssetToCAsset: (asset: XAsset) => CAsset;

package/lib/protocols/index.d.ts

@@ -1,2 +1,3 @@
 export { MayachainProtocol } from './mayachain';
 export { ThorchainProtocol } from './thorchain';
+export { ChainflipProtocol } from './chainflip';

package/lib/types.d.ts

@@ -15,7 +15,7 @@ type Fees = {
     affiliateFee: CryptoAmount;
     outboundFee: CryptoAmount;
 };
-type Protocol = 'Thorchain' | 'Mayachain';
+type Protocol = 'Thorchain' | 'Mayachain' | 'Chainflip';
 /**
  * Represents a quote for a swap operation.
  */
@@ -62,7 +62,7 @@ type SwapResume = {
     date: Date;
     status: 'success' | 'pending';
     inboundTx: TransactionAction;
-    outboundTx: TransactionAction;
+    outboundTx?: TransactionAction;
 };
 type SwapHistory = {
     count: number;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@xchainjs/xchain-aggregator",
   "description": "Protocol aggregator to make actions in different protocols",
-  "version": "0.1.18",
+  "version": "0.2.0",
   "license": "MIT",
   "main": "lib/index.js",
   "module": "lib/index.esm.js",
@@ -29,22 +29,23 @@
     "directory": "release/package"
   },
   "dependencies": {
+    "@chainflip/sdk": "1.3.0",
     "@xchainjs/xchain-client": "0.16.7",
-    "@xchainjs/xchain-mayachain": "1.0.8",
-    "@xchainjs/xchain-mayachain-amm": "2.0.7",
-    "@xchainjs/xchain-mayachain-query": "0.1.15",
-    "@xchainjs/xchain-thorchain": "1.0.11",
-    "@xchainjs/xchain-thorchain-amm": "1.1.12",
-    "@xchainjs/xchain-thorchain-query": "0.7.13",
+    "@xchainjs/xchain-mayachain": "1.0.10",
+    "@xchainjs/xchain-mayachain-amm": "2.0.9",
+    "@xchainjs/xchain-mayachain-query": "0.1.16",
+    "@xchainjs/xchain-thorchain": "1.1.0",
+    "@xchainjs/xchain-thorchain-amm": "1.1.14",
+    "@xchainjs/xchain-thorchain-query": "0.7.14",
     "@xchainjs/xchain-util": "0.13.6",
-    "@xchainjs/xchain-wallet": "0.1.16"
+    "@xchainjs/xchain-wallet": "0.1.18"
   },
   "devDependencies": {
     "@xchainjs/xchain-avax": "0.5.5",
     "@xchainjs/xchain-binance": "5.7.16",
     "@xchainjs/xchain-bitcoin": "0.23.18",
     "@xchainjs/xchain-ethereum": "0.32.5",
-    "@xchainjs/xchain-kujira": "0.1.19",
+    "@xchainjs/xchain-kujira": "0.1.20",
     "axios": "1.3.6",
     "axios-mock-adapter": "1.20.0"
   }