@xchainjs/xchain-thorchain-amm 3.0.37 → 3.1.0

package/README.md

@@ -113,13 +113,3 @@ If you plan on using the publicly accessible endpoints listed below, ensure that
 - https://api.haskoin.com (BTC/BCH/LTC)
 - https://gateway.liquify.com/chain/thorchain_api
 
-Example
-
-```typescript
-import cosmosclient from '@cosmos-client/core'
-import axios from 'axios'
-import { register9Rheader } from '@xchainjs/xchain-util'
-
-register9Rheader(axios)
-register9Rheader(cosmosclient.config.globalAxios)
-```

package/lib/index.esm.js

@@ -3100,12 +3100,13 @@ class ThorchainAction {
         });
     }
     static makeProtocolAction(_a) {
-        return __awaiter(this, arguments, void 0, function* ({ wallet, assetAmount, memo }) {
+        return __awaiter(this, arguments, void 0, function* ({ wallet, assetAmount, memo, walletIndex, }) {
             const hash = yield wallet.deposit({
                 chain: THORChain,
                 asset: assetAmount.asset,
                 amount: assetAmount.baseAmount,
                 memo,
+                walletIndex,
             });
             return {
                 hash,
@@ -3114,7 +3115,7 @@ class ThorchainAction {
         });
     }
     static makeNonProtocolAction(_a) {
-        return __awaiter(this, arguments, void 0, function* ({ wallet, assetAmount, recipient, memo, }) {
+        return __awaiter(this, arguments, void 0, function* ({ wallet, assetAmount, recipient, memo, walletIndex, }) {
             // Non EVM actions
             if (!isProtocolEVMChain(assetAmount.asset.chain)) {
                 if (isProtocolBFTChain(assetAmount.asset.chain)) {
@@ -3123,6 +3124,7 @@ class ThorchainAction {
                         amount: assetAmount.baseAmount,
                         recipient,
                         memo,
+                        walletIndex,
                     });
                     return {
                         hash,
@@ -3136,6 +3138,7 @@ class ThorchainAction {
                     recipient,
                     memo,
                     feeRate: feeRates.fast,
+                    walletIndex,
                 });
                 return {
                     hash,
@@ -3171,6 +3174,7 @@ class ThorchainAction {
                 gasPrice: gasPrices.fast,
                 isMemoEncoded: true,
                 gasLimit: new BigNumber(160000),
+                walletIndex,
             });
             return {
                 hash,
@@ -3236,7 +3240,7 @@ class ThorchainAMM {
      * @returns The estimated swap details.
      */
     estimateSwap(_a) {
-        return __awaiter(this, arguments, void 0, function* ({ fromAddress, fromAsset, amount, destinationAsset, destinationAddress, affiliateAddress = '', affiliateBps = 0, toleranceBps, liquidityToleranceBps, streamingInterval, streamingQuantity, }) {
+        return __awaiter(this, arguments, void 0, function* ({ fromAddress, fromAsset, amount, destinationAsset, destinationAddress, affiliateAddress = '', affiliateBps = 0, affiliates, toleranceBps, liquidityToleranceBps, streamingInterval, streamingQuantity, }) {
             const errors = yield this.validateSwap({
                 fromAddress,
                 fromAsset,
@@ -3251,6 +3255,7 @@ class ThorchainAMM {
                 destinationAddress,
                 affiliateAddress,
                 affiliateBps,
+                affiliates,
                 toleranceBps,
                 liquidityToleranceBps,
                 streamingInterval,
@@ -3268,7 +3273,7 @@ class ThorchainAMM {
      * @returns {string[]} the reasons the swap can not be done. If it is empty there are no reason to avoid the swap
      */
     validateSwap(_a) {
-        return __awaiter(this, arguments, void 0, function* ({ fromAsset, fromAddress, destinationAsset, destinationAddress, amount, affiliateAddress, affiliateBps, streamingInterval, streamingQuantity, }) {
+        return __awaiter(this, arguments, void 0, function* ({ fromAsset, fromAddress, destinationAsset, destinationAddress, amount, affiliateAddress, affiliateBps, affiliates, streamingInterval, streamingQuantity, }) {
             const errors = [];
             if (destinationAddress &&
                 !validateAddress(this.thorchainQuery.thorchainCache.midgardQuery.midgardCache.midgard.network, isSynthAsset(destinationAsset) || isTradeAsset(destinationAsset) || isSecuredAsset(destinationAsset)
@@ -3282,14 +3287,36 @@ class ThorchainAMM {
             if (isTradeAsset(fromAsset) && !isTradeAsset(destinationAsset) && !eqAsset(destinationAsset, AssetRuneNative)) {
                 errors.push('Can not make swap from trade asset to non trade asset or non Rune asset. Use withdrawFromTrade (TRADE-) operation');
             }
-            if (affiliateAddress) {
-                const isThorAddress = validateAddress(this.thorchainQuery.thorchainCache.midgardQuery.midgardCache.midgard.network, THORChain, affiliateAddress);
-                const isThorname = !!(yield this.thorchainQuery.thorchainCache.midgardQuery.midgardCache.midgard.getTHORNameDetails(affiliateAddress));
-                if (!(isThorAddress || isThorname))
+            // Reject mixing the singular form with the multi-affiliate array — the protocol's quote
+            // endpoint reads them from the same query params, so passing both produces ambiguous wire output.
+            if (affiliates && (affiliateAddress || affiliateBps !== undefined)) {
+                errors.push('affiliates is mutually exclusive with affiliateAddress / affiliateBps; pass one form, not both');
+            }
+            if (affiliates) {
+                if (affiliates.length === 0) {
+                    errors.push('affiliates array is empty; omit the field or include at least one entry');
+                }
+                // THORChain consensus caps the affiliate count at 5 per swap (MultipleAffiliatesMaxCount).
+                if (affiliates.length > 5) {
+                    errors.push(`affiliates count ${affiliates.length} exceeds THORChain maximum of 5`);
+                }
+                for (const a of affiliates) {
+                    const valid = yield this.isThorAffiliateAddress(a.address);
+                    if (!valid)
+                        errors.push(`affiliate address ${a.address} is not a valid THOR address or THORName`);
+                    if (a.bps < 0 || a.bps > 1000) {
+                        errors.push(`affiliate bps ${a.bps} for ${a.address} out of range [0 - 1000]`);
+                    }
+                }
+            }
+            else if (affiliateAddress) {
+                const valid = yield this.isThorAffiliateAddress(affiliateAddress);
+                if (!valid)
                     errors.push(`affiliateAddress ${affiliateAddress} is not a valid THOR address`);
             }
-            if (affiliateBps && (affiliateBps < 0 || affiliateBps > 10000)) {
-                errors.push(`affiliateBps ${affiliateBps} out of range [0 - 10000]`);
+            // THORChain caps single-affiliate bps at 1000 (10%); previous limit of 10000 was wider than the protocol accepts.
+            if (affiliateBps !== undefined && (affiliateBps < 0 || affiliateBps > 1000)) {
+                errors.push(`affiliateBps ${affiliateBps} out of range [0 - 1000]`);
             }
             if (streamingInterval && streamingInterval < 0) {
                 errors.push(`streamingInterval ${streamingInterval} can not be lower than zero`);
@@ -3313,6 +3340,23 @@ class ThorchainAMM {
             return errors;
         });
     }
+    /**
+     * Returns true if the given identifier is either a valid THOR bech32 address or a registered THORName.
+     */
+    isThorAffiliateAddress(identifier) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const network = this.thorchainQuery.thorchainCache.midgardQuery.midgardCache.midgard.network;
+            if (validateAddress(network, THORChain, identifier))
+                return true;
+            try {
+                const thorname = yield this.thorchainQuery.thorchainCache.midgardQuery.midgardCache.midgard.getTHORNameDetails(identifier);
+                return !!thorname;
+            }
+            catch (_a) {
+                return false;
+            }
+        });
+    }
     /**
      * Conducts a swap with the given inputs. This method should be called after estimateSwap() to ensure the swap is valid.
      *
@@ -3321,7 +3365,7 @@ class ThorchainAMM {
      * @returns {SwapSubmitted} - The transaction hash, URL of BlockExplorer, and expected wait time.
      */
     doSwap(_a) {
-        return __awaiter(this, arguments, void 0, function* ({ fromAsset, fromAddress, amount, destinationAsset, destinationAddress, affiliateAddress, affiliateBps, toleranceBps, streamingInterval, streamingQuantity, }) {
+        return __awaiter(this, arguments, void 0, function* ({ fromAsset, fromAddress, amount, destinationAsset, destinationAddress, affiliateAddress, affiliateBps, affiliates, toleranceBps, streamingInterval, streamingQuantity, }) {
             // Retrieve swap details from ThorchainQuery to ensure validity
             const txDetails = yield this.thorchainQuery.quoteSwap({
                 fromAsset,
@@ -3331,6 +3375,7 @@ class ThorchainAMM {
                 destinationAddress,
                 affiliateAddress,
                 affiliateBps,
+                affiliates,
                 toleranceBps,
                 streamingInterval,
                 streamingQuantity,

package/lib/index.js

@@ -3102,12 +3102,13 @@ class ThorchainAction {
         });
     }
     static makeProtocolAction(_a) {
-        return __awaiter(this, arguments, void 0, function* ({ wallet, assetAmount, memo }) {
+        return __awaiter(this, arguments, void 0, function* ({ wallet, assetAmount, memo, walletIndex, }) {
             const hash = yield wallet.deposit({
                 chain: xchainThorchain.THORChain,
                 asset: assetAmount.asset,
                 amount: assetAmount.baseAmount,
                 memo,
+                walletIndex,
             });
             return {
                 hash,
@@ -3116,7 +3117,7 @@ class ThorchainAction {
         });
     }
     static makeNonProtocolAction(_a) {
-        return __awaiter(this, arguments, void 0, function* ({ wallet, assetAmount, recipient, memo, }) {
+        return __awaiter(this, arguments, void 0, function* ({ wallet, assetAmount, recipient, memo, walletIndex, }) {
             // Non EVM actions
             if (!isProtocolEVMChain(assetAmount.asset.chain)) {
                 if (isProtocolBFTChain(assetAmount.asset.chain)) {
@@ -3125,6 +3126,7 @@ class ThorchainAction {
                         amount: assetAmount.baseAmount,
                         recipient,
                         memo,
+                        walletIndex,
                     });
                     return {
                         hash,
@@ -3138,6 +3140,7 @@ class ThorchainAction {
                     recipient,
                     memo,
                     feeRate: feeRates.fast,
+                    walletIndex,
                 });
                 return {
                     hash,
@@ -3173,6 +3176,7 @@ class ThorchainAction {
                 gasPrice: gasPrices.fast,
                 isMemoEncoded: true,
                 gasLimit: new BigNumber(160000),
+                walletIndex,
             });
             return {
                 hash,
@@ -3238,7 +3242,7 @@ class ThorchainAMM {
      * @returns The estimated swap details.
      */
     estimateSwap(_a) {
-        return __awaiter(this, arguments, void 0, function* ({ fromAddress, fromAsset, amount, destinationAsset, destinationAddress, affiliateAddress = '', affiliateBps = 0, toleranceBps, liquidityToleranceBps, streamingInterval, streamingQuantity, }) {
+        return __awaiter(this, arguments, void 0, function* ({ fromAddress, fromAsset, amount, destinationAsset, destinationAddress, affiliateAddress = '', affiliateBps = 0, affiliates, toleranceBps, liquidityToleranceBps, streamingInterval, streamingQuantity, }) {
             const errors = yield this.validateSwap({
                 fromAddress,
                 fromAsset,
@@ -3253,6 +3257,7 @@ class ThorchainAMM {
                 destinationAddress,
                 affiliateAddress,
                 affiliateBps,
+                affiliates,
                 toleranceBps,
                 liquidityToleranceBps,
                 streamingInterval,
@@ -3270,7 +3275,7 @@ class ThorchainAMM {
      * @returns {string[]} the reasons the swap can not be done. If it is empty there are no reason to avoid the swap
      */
     validateSwap(_a) {
-        return __awaiter(this, arguments, void 0, function* ({ fromAsset, fromAddress, destinationAsset, destinationAddress, amount, affiliateAddress, affiliateBps, streamingInterval, streamingQuantity, }) {
+        return __awaiter(this, arguments, void 0, function* ({ fromAsset, fromAddress, destinationAsset, destinationAddress, amount, affiliateAddress, affiliateBps, affiliates, streamingInterval, streamingQuantity, }) {
             const errors = [];
             if (destinationAddress &&
                 !validateAddress(this.thorchainQuery.thorchainCache.midgardQuery.midgardCache.midgard.network, xchainUtil.isSynthAsset(destinationAsset) || xchainUtil.isTradeAsset(destinationAsset) || xchainUtil.isSecuredAsset(destinationAsset)
@@ -3284,14 +3289,36 @@ class ThorchainAMM {
             if (xchainUtil.isTradeAsset(fromAsset) && !xchainUtil.isTradeAsset(destinationAsset) && !xchainUtil.eqAsset(destinationAsset, xchainThorchain.AssetRuneNative)) {
                 errors.push('Can not make swap from trade asset to non trade asset or non Rune asset. Use withdrawFromTrade (TRADE-) operation');
             }
-            if (affiliateAddress) {
-                const isThorAddress = validateAddress(this.thorchainQuery.thorchainCache.midgardQuery.midgardCache.midgard.network, xchainThorchain.THORChain, affiliateAddress);
-                const isThorname = !!(yield this.thorchainQuery.thorchainCache.midgardQuery.midgardCache.midgard.getTHORNameDetails(affiliateAddress));
-                if (!(isThorAddress || isThorname))
+            // Reject mixing the singular form with the multi-affiliate array — the protocol's quote
+            // endpoint reads them from the same query params, so passing both produces ambiguous wire output.
+            if (affiliates && (affiliateAddress || affiliateBps !== undefined)) {
+                errors.push('affiliates is mutually exclusive with affiliateAddress / affiliateBps; pass one form, not both');
+            }
+            if (affiliates) {
+                if (affiliates.length === 0) {
+                    errors.push('affiliates array is empty; omit the field or include at least one entry');
+                }
+                // THORChain consensus caps the affiliate count at 5 per swap (MultipleAffiliatesMaxCount).
+                if (affiliates.length > 5) {
+                    errors.push(`affiliates count ${affiliates.length} exceeds THORChain maximum of 5`);
+                }
+                for (const a of affiliates) {
+                    const valid = yield this.isThorAffiliateAddress(a.address);
+                    if (!valid)
+                        errors.push(`affiliate address ${a.address} is not a valid THOR address or THORName`);
+                    if (a.bps < 0 || a.bps > 1000) {
+                        errors.push(`affiliate bps ${a.bps} for ${a.address} out of range [0 - 1000]`);
+                    }
+                }
+            }
+            else if (affiliateAddress) {
+                const valid = yield this.isThorAffiliateAddress(affiliateAddress);
+                if (!valid)
                     errors.push(`affiliateAddress ${affiliateAddress} is not a valid THOR address`);
             }
-            if (affiliateBps && (affiliateBps < 0 || affiliateBps > 10000)) {
-                errors.push(`affiliateBps ${affiliateBps} out of range [0 - 10000]`);
+            // THORChain caps single-affiliate bps at 1000 (10%); previous limit of 10000 was wider than the protocol accepts.
+            if (affiliateBps !== undefined && (affiliateBps < 0 || affiliateBps > 1000)) {
+                errors.push(`affiliateBps ${affiliateBps} out of range [0 - 1000]`);
             }
             if (streamingInterval && streamingInterval < 0) {
                 errors.push(`streamingInterval ${streamingInterval} can not be lower than zero`);
@@ -3315,6 +3342,23 @@ class ThorchainAMM {
             return errors;
         });
     }
+    /**
+     * Returns true if the given identifier is either a valid THOR bech32 address or a registered THORName.
+     */
+    isThorAffiliateAddress(identifier) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const network = this.thorchainQuery.thorchainCache.midgardQuery.midgardCache.midgard.network;
+            if (validateAddress(network, xchainThorchain.THORChain, identifier))
+                return true;
+            try {
+                const thorname = yield this.thorchainQuery.thorchainCache.midgardQuery.midgardCache.midgard.getTHORNameDetails(identifier);
+                return !!thorname;
+            }
+            catch (_a) {
+                return false;
+            }
+        });
+    }
     /**
      * Conducts a swap with the given inputs. This method should be called after estimateSwap() to ensure the swap is valid.
      *
@@ -3323,7 +3367,7 @@ class ThorchainAMM {
      * @returns {SwapSubmitted} - The transaction hash, URL of BlockExplorer, and expected wait time.
      */
     doSwap(_a) {
-        return __awaiter(this, arguments, void 0, function* ({ fromAsset, fromAddress, amount, destinationAsset, destinationAddress, affiliateAddress, affiliateBps, toleranceBps, streamingInterval, streamingQuantity, }) {
+        return __awaiter(this, arguments, void 0, function* ({ fromAsset, fromAddress, amount, destinationAsset, destinationAddress, affiliateAddress, affiliateBps, affiliates, toleranceBps, streamingInterval, streamingQuantity, }) {
             // Retrieve swap details from ThorchainQuery to ensure validity
             const txDetails = yield this.thorchainQuery.quoteSwap({
                 fromAsset,
@@ -3333,6 +3377,7 @@ class ThorchainAMM {
                 destinationAddress,
                 affiliateAddress,
                 affiliateBps,
+                affiliates,
                 toleranceBps,
                 streamingInterval,
                 streamingQuantity,

package/lib/thorchain-action.d.ts

@@ -7,11 +7,13 @@ export type NonProtocolActionParams = {
     assetAmount: CryptoAmount<Asset | TokenAsset>;
     recipient: Address;
     memo: string;
+    walletIndex?: number;
 };
 export type ProtocolActionParams = {
     wallet: Wallet;
     assetAmount: CryptoAmount<CompatibleAsset>;
     memo: string;
+    walletIndex?: number;
 };
 export type ActionParams = ProtocolActionParams | NonProtocolActionParams;
 export declare class ThorchainAction {

package/lib/thorchain-amm.d.ts

@@ -26,13 +26,17 @@ export declare class ThorchainAMM {
   
      * @returns The estimated swap details.
      */
-    estimateSwap({ fromAddress, fromAsset, amount, destinationAsset, destinationAddress, affiliateAddress, affiliateBps, toleranceBps, liquidityToleranceBps, streamingInterval, streamingQuantity, }: QuoteSwapParams): Promise<TxDetails>;
+    estimateSwap({ fromAddress, fromAsset, amount, destinationAsset, destinationAddress, affiliateAddress, affiliateBps, affiliates, toleranceBps, liquidityToleranceBps, streamingInterval, streamingQuantity, }: QuoteSwapParams): Promise<TxDetails>;
     /**
      * Validate swap params
      * @param {QuoteSwapParams} quoteSwapParams Swap params
      * @returns {string[]} the reasons the swap can not be done. If it is empty there are no reason to avoid the swap
      */
-    validateSwap({ fromAsset, fromAddress, destinationAsset, destinationAddress, amount, affiliateAddress, affiliateBps, streamingInterval, streamingQuantity, }: QuoteSwapParams): Promise<string[]>;
+    validateSwap({ fromAsset, fromAddress, destinationAsset, destinationAddress, amount, affiliateAddress, affiliateBps, affiliates, streamingInterval, streamingQuantity, }: QuoteSwapParams): Promise<string[]>;
+    /**
+     * Returns true if the given identifier is either a valid THOR bech32 address or a registered THORName.
+     */
+    private isThorAffiliateAddress;
     /**
      * Conducts a swap with the given inputs. This method should be called after estimateSwap() to ensure the swap is valid.
      *
@@ -40,7 +44,7 @@ export declare class ThorchainAMM {
      * @param params - The swap parameters.
      * @returns {SwapSubmitted} - The transaction hash, URL of BlockExplorer, and expected wait time.
      */
-    doSwap({ fromAsset, fromAddress, amount, destinationAsset, destinationAddress, affiliateAddress, affiliateBps, toleranceBps, streamingInterval, streamingQuantity, }: QuoteSwapParams): Promise<TxSubmitted>;
+    doSwap({ fromAsset, fromAddress, amount, destinationAsset, destinationAddress, affiliateAddress, affiliateBps, affiliates, toleranceBps, streamingInterval, streamingQuantity, }: QuoteSwapParams): Promise<TxSubmitted>;
     /**
      * Approve the Thorchain router to spend a certain amount in the asset chain.
      * @param {ApproveParams} approveParams Parameters for approving the router to spend

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xchainjs/xchain-thorchain-amm",
-  "version": "3.0.37",
+  "version": "3.1.0",
   "description": "module that exposes estimating & swappping cryptocurrency assets on thorchain",
   "keywords": [
     "THORChain",
@@ -36,31 +36,31 @@
     "url": "https://github.com/xchainjs/xchainjs-lib/issues"
   },
   "dependencies": {
-    "@xchainjs/xchain-avax": "2.0.17",
-    "@xchainjs/xchain-base": "1.0.17",
-    "@xchainjs/xchain-bitcoin": "2.2.4",
-    "@xchainjs/xchain-bitcoincash": "2.2.5",
-    "@xchainjs/xchain-bsc": "2.0.18",
-    "@xchainjs/xchain-client": "2.0.13",
-    "@xchainjs/xchain-cosmos": "3.0.13",
-    "@xchainjs/xchain-doge": "2.2.4",
-    "@xchainjs/xchain-ethereum": "2.0.18",
-    "@xchainjs/xchain-evm": "2.0.17",
-    "@xchainjs/xchain-litecoin": "2.3.1",
-    "@xchainjs/xchain-ripple": "1.0.15",
-    "@xchainjs/xchain-solana": "1.1.5",
-    "@xchainjs/xchain-sui": "0.1.2",
-    "@xchainjs/xchain-thorchain": "3.0.17",
-    "@xchainjs/xchain-thorchain-query": "3.0.4",
-    "@xchainjs/xchain-tron": "3.0.6",
+    "@xchainjs/xchain-avax": "2.0.18",
+    "@xchainjs/xchain-base": "1.0.18",
+    "@xchainjs/xchain-bitcoin": "2.2.6",
+    "@xchainjs/xchain-bitcoincash": "2.2.7",
+    "@xchainjs/xchain-bsc": "2.0.19",
+    "@xchainjs/xchain-client": "2.0.14",
+    "@xchainjs/xchain-cosmos": "3.0.14",
+    "@xchainjs/xchain-doge": "2.2.6",
+    "@xchainjs/xchain-ethereum": "2.0.19",
+    "@xchainjs/xchain-evm": "2.0.18",
+    "@xchainjs/xchain-litecoin": "2.3.3",
+    "@xchainjs/xchain-ripple": "1.0.16",
+    "@xchainjs/xchain-solana": "1.1.6",
+    "@xchainjs/xchain-sui": "0.1.3",
+    "@xchainjs/xchain-thorchain": "3.0.18",
+    "@xchainjs/xchain-thorchain-query": "3.1.0",
+    "@xchainjs/xchain-tron": "3.0.7",
     "@xchainjs/xchain-util": "2.0.7",
-    "@xchainjs/xchain-wallet": "2.0.27",
-    "@xchainjs/xchain-zcash": "1.3.5",
+    "@xchainjs/xchain-wallet": "2.0.29",
+    "@xchainjs/xchain-zcash": "1.3.7",
     "ethers": "^6.14.3"
   },
   "devDependencies": {
     "@ledgerhq/hw-transport-node-hid": "^6.28.6",
-    "axios": "1.15.2",
+    "axios": "1.16.1",
     "axios-mock-adapter": "^2.1.0"
   },
   "publishConfig": {