@xchainjs/xchain-thorchain-amm 1.1.16 → 1.1.17

package/lib/index.esm.js

@@ -9,9 +9,9 @@ import { DOGEChain, Client as Client$6, defaultDogeParams } from '@xchainjs/xcha
 import { AssetETH, ETHChain, Client as Client$5, defaultEthParams } from '@xchainjs/xchain-ethereum';
 import { abi, MAX_APPROVAL } from '@xchainjs/xchain-evm';
 import { LTCChain, Client as Client$7, defaultLtcParams } from '@xchainjs/xchain-litecoin';
-import { THORChain, Client, defaultClientConfig } from '@xchainjs/xchain-thorchain';
+import { THORChain, Client, defaultClientConfig, RUNE_DECIMAL, AssetRuneNative } from '@xchainjs/xchain-thorchain';
 import { ThorchainQuery, ThorchainCache, Thornode } from '@xchainjs/xchain-thorchain-query';
-import { eqAsset, getContractAddressFromAsset, baseAmount } from '@xchainjs/xchain-util';
+import { eqAsset, getContractAddressFromAsset, baseAmount, CryptoAmount } from '@xchainjs/xchain-util';
 import { Wallet } from '@xchainjs/xchain-wallet';
 import { ethers } from 'ethers';
 
@@ -635,6 +635,120 @@ class ThorchainAMM {
             return this.thorchainQuery.thorchainCache.midgardQuery.midgardCache.midgard.getTHORNameReverseLookup(address);
         });
     }
+    /**
+     * Estimate the cost of a THORName registration
+     * @param {RegisterTHORName} params Params to make the registration
+     * @returns {QuoteTHORName} Memo to make the registration and the estimation of the operation
+     */
+    estimateTHORNameRegistration(params) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const errors = [];
+            if (!validateAddress(this.thorchainQuery.thorchainCache.midgardQuery.midgardCache.midgard.network, params.chain, params.chainAddress)) {
+                errors.push(`Invalid address ${params.chainAddress} for ${params.chain} chain`);
+            }
+            if (!validateAddress(this.thorchainQuery.thorchainCache.midgardQuery.midgardCache.midgard.network, THORChain, params.owner)) {
+                errors.push(`Invalid owner ${params.owner} due it is not a THORChain address`);
+            }
+            if (errors.length) {
+                return {
+                    memo: '',
+                    errors,
+                    value: new CryptoAmount(baseAmount(0, RUNE_DECIMAL), AssetRuneNative),
+                    allowed: false,
+                };
+            }
+            try {
+                const estimated = yield this.thorchainQuery.estimateThorname(Object.assign({}, params));
+                return Object.assign(Object.assign({}, estimated), { allowed: true, errors: [] });
+                // eslint-disable-next-line @typescript-eslint/no-explicit-any
+            }
+            catch (e) {
+                return {
+                    memo: '',
+                    errors: ['message' in e ? e.message : `Unknown error: ${e}`],
+                    value: new CryptoAmount(baseAmount(0, RUNE_DECIMAL), AssetRuneNative),
+                    allowed: false,
+                };
+            }
+        });
+    }
+    /**
+     * Estimate the cost of an update of a THORName
+     * @param {QuoteTHORNameParams} params Params to make the update
+     * @returns {QuoteTHORName} Memo to make the update and the estimation of the operation
+     */
+    estimateTHORNameUpdate(params) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const errors = [];
+            if ((params.chain && !params.chainAddress) || (!params.chain && params.chainAddress)) {
+                errors.push(`Alias not provided correctly`);
+            }
+            if (params.chain &&
+                params.chainAddress &&
+                !validateAddress(this.thorchainQuery.thorchainCache.midgardQuery.midgardCache.midgard.network, params.chain, params.chainAddress)) {
+                errors.push(`Invalid alias ${params.chainAddress} for ${params.chain} chain`);
+            }
+            if (params.owner &&
+                !validateAddress(this.thorchainQuery.thorchainCache.midgardQuery.midgardCache.midgard.network, THORChain, params.owner)) {
+                errors.push(`Invalid owner ${params.owner} due it is not a THORChain address`);
+            }
+            if (errors.length) {
+                return {
+                    memo: '',
+                    errors,
+                    value: new CryptoAmount(baseAmount(0, RUNE_DECIMAL), AssetRuneNative),
+                    allowed: false,
+                };
+            }
+            try {
+                const estimated = yield this.thorchainQuery.estimateThorname(Object.assign(Object.assign({}, params), { isUpdate: true }));
+                return Object.assign(Object.assign({}, estimated), { allowed: true, errors: [] });
+                // eslint-disable-next-line @typescript-eslint/no-explicit-any
+            }
+            catch (e) {
+                return {
+                    memo: '',
+                    errors: ['message' in e ? e.message : `Unknown error: ${e}`],
+                    value: new CryptoAmount(baseAmount(0, RUNE_DECIMAL), AssetRuneNative),
+                    allowed: false,
+                };
+            }
+        });
+    }
+    /**
+     * Register a THORName
+     * @param {RegisterTHORName} params Params to make the registration
+     * @returns {TxSubmitted} Transaction made to register the THORName
+     */
+    registerTHORName(params) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const quote = yield this.estimateTHORNameRegistration(params);
+            if (!quote.allowed)
+                throw Error(`Can not register THORName. ${quote.errors.join(' ')}`);
+            return ThorchainAction.makeAction({
+                wallet: this.wallet,
+                assetAmount: quote.value,
+                memo: quote.memo,
+            });
+        });
+    }
+    /**
+     * Update a THORName
+     * @param {UpdateTHORName} params Params to make the update
+     * @returns {TxSubmitted} Transaction made to update the THORName
+     */
+    updateTHORName(params) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const quote = yield this.estimateTHORNameUpdate(params);
+            if (!quote.allowed)
+                throw Error(`Can not update THORName. ${quote.errors.join(' ')}`);
+            return ThorchainAction.makeAction({
+                wallet: this.wallet,
+                assetAmount: quote.value,
+                memo: quote.memo,
+            });
+        });
+    }
 }
 
 export { ThorchainAMM };

package/lib/index.js

@@ -639,6 +639,120 @@ class ThorchainAMM {
             return this.thorchainQuery.thorchainCache.midgardQuery.midgardCache.midgard.getTHORNameReverseLookup(address);
         });
     }
+    /**
+     * Estimate the cost of a THORName registration
+     * @param {RegisterTHORName} params Params to make the registration
+     * @returns {QuoteTHORName} Memo to make the registration and the estimation of the operation
+     */
+    estimateTHORNameRegistration(params) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const errors = [];
+            if (!validateAddress(this.thorchainQuery.thorchainCache.midgardQuery.midgardCache.midgard.network, params.chain, params.chainAddress)) {
+                errors.push(`Invalid address ${params.chainAddress} for ${params.chain} chain`);
+            }
+            if (!validateAddress(this.thorchainQuery.thorchainCache.midgardQuery.midgardCache.midgard.network, xchainThorchain.THORChain, params.owner)) {
+                errors.push(`Invalid owner ${params.owner} due it is not a THORChain address`);
+            }
+            if (errors.length) {
+                return {
+                    memo: '',
+                    errors,
+                    value: new xchainUtil.CryptoAmount(xchainUtil.baseAmount(0, xchainThorchain.RUNE_DECIMAL), xchainThorchain.AssetRuneNative),
+                    allowed: false,
+                };
+            }
+            try {
+                const estimated = yield this.thorchainQuery.estimateThorname(Object.assign({}, params));
+                return Object.assign(Object.assign({}, estimated), { allowed: true, errors: [] });
+                // eslint-disable-next-line @typescript-eslint/no-explicit-any
+            }
+            catch (e) {
+                return {
+                    memo: '',
+                    errors: ['message' in e ? e.message : `Unknown error: ${e}`],
+                    value: new xchainUtil.CryptoAmount(xchainUtil.baseAmount(0, xchainThorchain.RUNE_DECIMAL), xchainThorchain.AssetRuneNative),
+                    allowed: false,
+                };
+            }
+        });
+    }
+    /**
+     * Estimate the cost of an update of a THORName
+     * @param {QuoteTHORNameParams} params Params to make the update
+     * @returns {QuoteTHORName} Memo to make the update and the estimation of the operation
+     */
+    estimateTHORNameUpdate(params) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const errors = [];
+            if ((params.chain && !params.chainAddress) || (!params.chain && params.chainAddress)) {
+                errors.push(`Alias not provided correctly`);
+            }
+            if (params.chain &&
+                params.chainAddress &&
+                !validateAddress(this.thorchainQuery.thorchainCache.midgardQuery.midgardCache.midgard.network, params.chain, params.chainAddress)) {
+                errors.push(`Invalid alias ${params.chainAddress} for ${params.chain} chain`);
+            }
+            if (params.owner &&
+                !validateAddress(this.thorchainQuery.thorchainCache.midgardQuery.midgardCache.midgard.network, xchainThorchain.THORChain, params.owner)) {
+                errors.push(`Invalid owner ${params.owner} due it is not a THORChain address`);
+            }
+            if (errors.length) {
+                return {
+                    memo: '',
+                    errors,
+                    value: new xchainUtil.CryptoAmount(xchainUtil.baseAmount(0, xchainThorchain.RUNE_DECIMAL), xchainThorchain.AssetRuneNative),
+                    allowed: false,
+                };
+            }
+            try {
+                const estimated = yield this.thorchainQuery.estimateThorname(Object.assign(Object.assign({}, params), { isUpdate: true }));
+                return Object.assign(Object.assign({}, estimated), { allowed: true, errors: [] });
+                // eslint-disable-next-line @typescript-eslint/no-explicit-any
+            }
+            catch (e) {
+                return {
+                    memo: '',
+                    errors: ['message' in e ? e.message : `Unknown error: ${e}`],
+                    value: new xchainUtil.CryptoAmount(xchainUtil.baseAmount(0, xchainThorchain.RUNE_DECIMAL), xchainThorchain.AssetRuneNative),
+                    allowed: false,
+                };
+            }
+        });
+    }
+    /**
+     * Register a THORName
+     * @param {RegisterTHORName} params Params to make the registration
+     * @returns {TxSubmitted} Transaction made to register the THORName
+     */
+    registerTHORName(params) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const quote = yield this.estimateTHORNameRegistration(params);
+            if (!quote.allowed)
+                throw Error(`Can not register THORName. ${quote.errors.join(' ')}`);
+            return ThorchainAction.makeAction({
+                wallet: this.wallet,
+                assetAmount: quote.value,
+                memo: quote.memo,
+            });
+        });
+    }
+    /**
+     * Update a THORName
+     * @param {UpdateTHORName} params Params to make the update
+     * @returns {TxSubmitted} Transaction made to update the THORName
+     */
+    updateTHORName(params) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const quote = yield this.estimateTHORNameUpdate(params);
+            if (!quote.allowed)
+                throw Error(`Can not update THORName. ${quote.errors.join(' ')}`);
+            return ThorchainAction.makeAction({
+                wallet: this.wallet,
+                assetAmount: quote.value,
+                memo: quote.memo,
+            });
+        });
+    }
 }
 
 exports.ThorchainAMM = ThorchainAMM;

package/lib/thorchain-amm.d.ts

@@ -1,7 +1,7 @@
-import { AddliquidityPosition, EstimateAddLP, EstimateAddSaver, EstimateWithdrawLP, EstimateWithdrawSaver, LoanCloseParams, LoanCloseQuote, LoanOpenParams, LoanOpenQuote, QuoteSwapParams, SaversPosition, SaversWithdraw, ThorchainQuery, TxDetails, WithdrawLiquidityPosition, getSaver } from '@xchainjs/xchain-thorchain-query';
+import { AddliquidityPosition, EstimateAddLP, EstimateAddSaver, EstimateWithdrawLP, EstimateWithdrawSaver, LoanCloseParams, LoanCloseQuote, LoanOpenParams, LoanOpenQuote, QuoteSwapParams, RegisterTHORName, SaversPosition, SaversWithdraw, ThorchainQuery, TxDetails, UpdateTHORName, WithdrawLiquidityPosition, getSaver } from '@xchainjs/xchain-thorchain-query';
 import { CryptoAmount } from '@xchainjs/xchain-util';
 import { Wallet } from '@xchainjs/xchain-wallet';
-import { ApproveParams, IsApprovedParams, TxSubmitted } from './types';
+import { ApproveParams, IsApprovedParams, QuoteTHORName, TxSubmitted } from './types';
 /**
  * THORChain Class for interacting with THORChain.
  * Recommended main class to use for swapping with THORChain
@@ -140,4 +140,28 @@ export declare class ThorchainAMM {
      * @returns The Thornames data.
      */
     getThornamesByAddress(address: string): Promise<import("@xchainjs/xchain-midgard/lib").ReverseTHORNames | undefined>;
+    /**
+     * Estimate the cost of a THORName registration
+     * @param {RegisterTHORName} params Params to make the registration
+     * @returns {QuoteTHORName} Memo to make the registration and the estimation of the operation
+     */
+    estimateTHORNameRegistration(params: RegisterTHORName): Promise<QuoteTHORName>;
+    /**
+     * Estimate the cost of an update of a THORName
+     * @param {QuoteTHORNameParams} params Params to make the update
+     * @returns {QuoteTHORName} Memo to make the update and the estimation of the operation
+     */
+    estimateTHORNameUpdate(params: UpdateTHORName): Promise<QuoteTHORName>;
+    /**
+     * Register a THORName
+     * @param {RegisterTHORName} params Params to make the registration
+     * @returns {TxSubmitted} Transaction made to register the THORName
+     */
+    registerTHORName(params: RegisterTHORName): Promise<TxSubmitted>;
+    /**
+     * Update a THORName
+     * @param {UpdateTHORName} params Params to make the update
+     * @returns {TxSubmitted} Transaction made to update the THORName
+     */
+    updateTHORName(params: UpdateTHORName): Promise<TxSubmitted>;
 }

package/lib/types.d.ts

@@ -1,5 +1,5 @@
 import { Balance, FeeOption } from '@xchainjs/xchain-client';
-import { LiquidityPool } from '@xchainjs/xchain-thorchain-query';
+import { LiquidityPool, QuoteTHORName as BaseQuoteTHORName } from '@xchainjs/xchain-thorchain-query';
 import { Address, Asset, BaseAmount, Chain, CryptoAmount } from '@xchainjs/xchain-util';
 /**
  * Represents the balance information for all assets on a particular chain.
@@ -114,3 +114,16 @@ export type ApproveParams = {
     asset: Asset;
     amount: CryptoAmount | undefined;
 };
+/**
+ * Estimation quote to register or update a THORName
+ */
+export type QuoteTHORName = BaseQuoteTHORName & {
+    /**
+     * If the action can be or not can be done
+     */
+    allowed: boolean;
+    /**
+     * If any, list of errors with the reason the operation is not allowed
+     */
+    errors: string[];
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xchainjs/xchain-thorchain-amm",
-  "version": "1.1.16",
+  "version": "1.1.17",
   "description": "module that exposes estimating & swappping cryptocurrency assets on thorchain",
   "keywords": [
     "THORChain",
@@ -48,7 +48,7 @@
     "@xchainjs/xchain-evm": "0.6.4",
     "@xchainjs/xchain-litecoin": "0.14.6",
     "@xchainjs/xchain-thorchain": "1.1.1",
-    "@xchainjs/xchain-thorchain-query": "0.7.15",
+    "@xchainjs/xchain-thorchain-query": "0.7.16",
     "@xchainjs/xchain-util": "0.13.7",
     "@xchainjs/xchain-wallet": "0.1.19",
     "ethers": "5.7.2"