@xchainjs/xchain-aggregator 0.2.0 → 0.2.2

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

@@ -1,15 +1,14 @@
 import { Asset, Chain } from '@xchainjs/xchain-util';
-import { Wallet } from '@xchainjs/xchain-wallet';
-import { IProtocol, QuoteSwap, QuoteSwapParams, SwapHistory, TxSubmitted } from '../../types';
+import { IProtocol, ProtocolConfig, QuoteSwap, QuoteSwapParams, SwapHistory, TxSubmitted } from '../../types';
 /**
  * Chainflip protocol
  */
 export declare class ChainflipProtocol implements IProtocol {
     readonly name = "Chainflip";
     private sdk;
-    private wallet;
+    private wallet?;
     private assetsData;
-    constructor(wallet?: Wallet);
+    constructor(configuration?: ProtocolConfig);
     /**
      * Check if an asset is supported in the protocol
      * @param {Asset} asset Asset to check if it is supported

package/lib/protocols/index.d.ts

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

package/lib/protocols/mayachain/mayachainProtocol.d.ts

@@ -1,11 +1,11 @@
 import { Asset, Chain } from '@xchainjs/xchain-util';
-import { Wallet } from '@xchainjs/xchain-wallet';
-import { IProtocol, QuoteSwap, QuoteSwapParams, SwapHistory, SwapHistoryParams, TxSubmitted } from '../../types';
+import { IProtocol, ProtocolConfig, QuoteSwap, QuoteSwapParams, SwapHistory, SwapHistoryParams, TxSubmitted } from '../../types';
 export declare class MayachainProtocol implements IProtocol {
-    readonly name: "Mayachain";
+    readonly name = "Mayachain";
     private mayachainQuery;
     private mayachainAmm;
-    constructor(wallet?: Wallet);
+    private configuration;
+    constructor(configuration?: ProtocolConfig);
     /**
      * Check if an asset is supported in the protocol
      * @param {Asset} asset Asset to check if it is supported

package/lib/protocols/protocolFactory.d.ts

@@ -0,0 +1,4 @@
+import { Config, IProtocol, Protocol } from '../types';
+export declare class ProtocolFactory {
+    static getProtocol(name: Protocol, configuration: Config): IProtocol;
+}

package/lib/protocols/thorchain/thorchainProtocol.d.ts

@@ -1,11 +1,11 @@
 import { Asset, Chain } from '@xchainjs/xchain-util';
-import { Wallet } from '@xchainjs/xchain-wallet';
-import { IProtocol, QuoteSwap, QuoteSwapParams, SwapHistory, SwapHistoryParams, TxSubmitted } from '../../types';
+import { IProtocol, ProtocolConfig, QuoteSwap, QuoteSwapParams, SwapHistory, SwapHistoryParams, TxSubmitted } from '../../types';
 export declare class ThorchainProtocol implements IProtocol {
-    readonly name: "Thorchain";
+    readonly name = "Thorchain";
     private thorchainQuery;
     private thorchainAmm;
-    constructor(wallet?: Wallet);
+    private configuration;
+    constructor(configuration?: ProtocolConfig);
     /**
      * Check if an asset is supported in the protocol
      * @param {Asset} asset Asset to check if it is supported

package/lib/types.d.ts

@@ -1,5 +1,6 @@
 import { TxHash } from '@xchainjs/xchain-client';
 import { Address, Asset, Chain, CryptoAmount } from '@xchainjs/xchain-util';
+import { Wallet } from '@xchainjs/xchain-wallet';
 /**
  * TxSubmitted
  */
@@ -15,7 +16,48 @@ type Fees = {
     affiliateFee: CryptoAmount;
     outboundFee: CryptoAmount;
 };
+/**
+ * Protocols supported by the Aggregator
+ */
 type Protocol = 'Thorchain' | 'Mayachain' | 'Chainflip';
+/**
+ * Affiliate config for the aggregator
+ */
+type AffiliateConfig = {
+    /**
+     * Basis points for the affiliate fee calculation. Value must be between 0 and 10000
+     */
+    basisPoints: number;
+    /**
+     * Affiliate address by protocol. ThorNames and MayaNames are supported for Thorchain and Mayachain protocols
+     */
+    affiliates: Partial<Record<Protocol, string>>;
+};
+/**
+ * Aggregator config
+ */
+export type Config = Partial<{
+    /**
+     * List of protocols to enable. Undefined value means all protocols enabled
+     */
+    protocols: Protocol[];
+    /**
+     * Affiliate config
+     */
+    affiliate: AffiliateConfig;
+    /**
+     * Wallet
+     */
+    wallet: Wallet;
+}>;
+/**
+ * Protocol config
+ */
+export type ProtocolConfig = Partial<{
+    wallet: Wallet;
+    affiliateBps: number;
+    affiliateAddress: string;
+}>;
 /**
  * Represents a quote for a swap operation.
  */
@@ -43,8 +85,6 @@ type QuoteSwapParams = {
     destinationAddress?: string;
     height?: number;
     toleranceBps?: number;
-    affiliateBps?: number;
-    affiliateAddress?: string;
 };
 type SwapHistoryParams = {
     chainAddresses: {
@@ -69,7 +109,7 @@ type SwapHistory = {
     swaps: SwapResume[];
 };
 interface IProtocol {
-    name: string;
+    name: Protocol;
     isAssetSupported(asset: Asset): Promise<boolean>;
     getSupportedChains(): Promise<Chain[]>;
     estimateSwap(params: QuoteSwapParams): Promise<QuoteSwap>;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@xchainjs/xchain-aggregator",
   "description": "Protocol aggregator to make actions in different protocols",
-  "version": "0.2.0",
+  "version": "0.2.2",
   "license": "MIT",
   "main": "lib/index.js",
   "module": "lib/index.esm.js",
@@ -30,22 +30,22 @@
   },
   "dependencies": {
     "@chainflip/sdk": "1.3.0",
-    "@xchainjs/xchain-client": "0.16.7",
-    "@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.18"
+    "@xchainjs/xchain-client": "0.16.8",
+    "@xchainjs/xchain-mayachain": "1.0.11",
+    "@xchainjs/xchain-mayachain-amm": "2.0.11",
+    "@xchainjs/xchain-mayachain-query": "0.1.18",
+    "@xchainjs/xchain-thorchain": "1.1.1",
+    "@xchainjs/xchain-thorchain-amm": "1.1.16",
+    "@xchainjs/xchain-thorchain-query": "0.7.15",
+    "@xchainjs/xchain-util": "0.13.7",
+    "@xchainjs/xchain-wallet": "0.1.19"
   },
   "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.20",
+    "@xchainjs/xchain-avax": "0.5.6",
+    "@xchainjs/xchain-binance": "5.7.17",
+    "@xchainjs/xchain-bitcoin": "0.23.19",
+    "@xchainjs/xchain-ethereum": "0.32.6",
+    "@xchainjs/xchain-kujira": "0.1.21",
     "axios": "1.3.6",
     "axios-mock-adapter": "1.20.0"
   }