@xchainjs/xchain-thorchain-amm 0.7.0 → 0.7.2

package/lib/index.esm.js

@@ -1,6 +1,6 @@
 import { Client as Client$9, defaultAvaxParams } from '@xchainjs/xchain-avax';
 import { Client as Client$5 } from '@xchainjs/xchain-binance';
-import { Client as Client$1 } from '@xchainjs/xchain-bitcoin';
+import { Client as Client$1, BTCChain } from '@xchainjs/xchain-bitcoin';
 import { Client } from '@xchainjs/xchain-bitcoincash';
 import { Client as Client$a, defaultBscParams } from '@xchainjs/xchain-bsc';
 import { FeeOption } from '@xchainjs/xchain-client';
@@ -10,8 +10,8 @@ import { Client as Client$8, defaultEthParams } from '@xchainjs/xchain-ethereum'
 import { Client as Client$3 } from '@xchainjs/xchain-litecoin';
 import { Client as Client$7 } from '@xchainjs/xchain-mayachain';
 import { Client as Client$4, THORChain } from '@xchainjs/xchain-thorchain';
+import { eqAsset, getContractAddressFromAsset, baseAmount, assetFromString } from '@xchainjs/xchain-util';
 import { abi, MAX_APPROVAL } from '@xchainjs/xchain-evm';
-import { eqAsset, getContractAddressFromAsset, baseAmount } from '@xchainjs/xchain-util';
 import { ethers } from 'ethers';
 import { ThorchainQuery } from '@xchainjs/xchain-thorchain-query';
 
@@ -533,6 +533,67 @@ class Wallet {
             }
         });
     }
+    /**
+     * Register a THORName with a default expirity of one year. By default chain and chainAddress is getting from wallet instance and is BTC.
+     * By default owner is getting from wallet
+     * @param thorname - Name to register
+     * @param chain - Chain to add alias
+     * @param chainAddress - Address to add to chain alias
+     * @param owner - Owner address (rune address)
+     * @param preferredAsset - referred asset
+     * @param expirity - expirity of the domain in MILLISECONDS
+     * @param isUpdate - true only if the domain is already register and you want to update its data
+     * @returns memo and value of deposit
+     */
+    registerThorname(params) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const chainClient = this.clients[params.chain || BTCChain];
+            const thorClient = this.clients.THOR;
+            if (!chainClient || !thorClient) {
+                throw Error('Can not find a wallet client');
+            }
+            const thornameEstimation = yield this.thorchainQuery.estimateThorname(Object.assign(Object.assign({}, params), { chain: params.chain || BTCChain, chainAddress: params.chainAddress || chainClient.getAddress(), owner: params.owner || thorClient.getAddress() }));
+            const castedThorClient = thorClient;
+            const result = yield castedThorClient.deposit({
+                asset: thornameEstimation.value.asset,
+                amount: thornameEstimation.value.baseAmount,
+                memo: thornameEstimation.memo,
+            });
+            return result;
+        });
+    }
+    /**
+     * Register a THORName with a default expirity of one year. By default chain and chainAddress is getting from wallet instance and is BTC.
+     * By default owner is getting from wallet
+     * @param thorname - Name to register
+     * @param chain - Chain to add alias
+     * @param chainAddress - Address to add to chain alias
+     * @param owner - Owner address (rune address)
+     * @param preferredAsset - referred asset
+     * @param expirity - expirity of the domain in MILLISECONDS
+     * @returns memo and value of deposit
+     */
+    updateThorname(params) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const chainClient = this.clients[params.chain || BTCChain];
+            const thorClient = this.clients.THOR;
+            if (!chainClient || !thorClient) {
+                throw Error('Can not find a wallet client');
+            }
+            const thornameDetail = yield this.thorchainQuery.getThornameDetails(params.thorname);
+            if ((thornameDetail === null || thornameDetail === void 0 ? void 0 : thornameDetail.owner) !== thorClient.getAddress()) {
+                throw Error('You cannot update a domain that is not yours');
+            }
+            const thornameEstimation = yield this.thorchainQuery.estimateThorname(Object.assign(Object.assign({}, params), { chain: params.chain || BTCChain, isUpdate: true, preferredAsset: params.preferredAsset || assetFromString(thornameDetail.preferredAsset), chainAddress: params.chainAddress || chainClient.getAddress() }));
+            const castedThorClient = thorClient;
+            const result = yield castedThorClient.deposit({
+                asset: thornameEstimation.value.asset,
+                amount: thornameEstimation.value.baseAmount,
+                memo: thornameEstimation.memo,
+            });
+            return result;
+        });
+    }
     /** Function handles liquidity add for all non rune assets
      *
      * @param params - parameters for add liquidity
@@ -916,6 +977,16 @@ class ThorchainAMM {
             });
         });
     }
+    /**
+     * Get all Thornames and its data associated owned by an address
+     * @param address - address
+     * @returns thornames data
+     */
+    getThornamesByAddress(address) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.thorchainQuery.thorchainCache.midgardQuery.midgardCache.midgard.getTHORNameReverseLookup(address);
+        });
+    }
 }
 
 export { ThorchainAMM, Wallet };

package/lib/index.js

@@ -14,8 +14,8 @@ var xchainEthereum = require('@xchainjs/xchain-ethereum');
 var xchainLitecoin = require('@xchainjs/xchain-litecoin');
 var xchainMayachain = require('@xchainjs/xchain-mayachain');
 var xchainThorchain = require('@xchainjs/xchain-thorchain');
-var xchainEvm = require('@xchainjs/xchain-evm');
 var xchainUtil = require('@xchainjs/xchain-util');
+var xchainEvm = require('@xchainjs/xchain-evm');
 var ethers = require('ethers');
 var xchainThorchainQuery = require('@xchainjs/xchain-thorchain-query');
 
@@ -537,6 +537,67 @@ class Wallet {
             }
         });
     }
+    /**
+     * Register a THORName with a default expirity of one year. By default chain and chainAddress is getting from wallet instance and is BTC.
+     * By default owner is getting from wallet
+     * @param thorname - Name to register
+     * @param chain - Chain to add alias
+     * @param chainAddress - Address to add to chain alias
+     * @param owner - Owner address (rune address)
+     * @param preferredAsset - referred asset
+     * @param expirity - expirity of the domain in MILLISECONDS
+     * @param isUpdate - true only if the domain is already register and you want to update its data
+     * @returns memo and value of deposit
+     */
+    registerThorname(params) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const chainClient = this.clients[params.chain || xchainBitcoin.BTCChain];
+            const thorClient = this.clients.THOR;
+            if (!chainClient || !thorClient) {
+                throw Error('Can not find a wallet client');
+            }
+            const thornameEstimation = yield this.thorchainQuery.estimateThorname(Object.assign(Object.assign({}, params), { chain: params.chain || xchainBitcoin.BTCChain, chainAddress: params.chainAddress || chainClient.getAddress(), owner: params.owner || thorClient.getAddress() }));
+            const castedThorClient = thorClient;
+            const result = yield castedThorClient.deposit({
+                asset: thornameEstimation.value.asset,
+                amount: thornameEstimation.value.baseAmount,
+                memo: thornameEstimation.memo,
+            });
+            return result;
+        });
+    }
+    /**
+     * Register a THORName with a default expirity of one year. By default chain and chainAddress is getting from wallet instance and is BTC.
+     * By default owner is getting from wallet
+     * @param thorname - Name to register
+     * @param chain - Chain to add alias
+     * @param chainAddress - Address to add to chain alias
+     * @param owner - Owner address (rune address)
+     * @param preferredAsset - referred asset
+     * @param expirity - expirity of the domain in MILLISECONDS
+     * @returns memo and value of deposit
+     */
+    updateThorname(params) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const chainClient = this.clients[params.chain || xchainBitcoin.BTCChain];
+            const thorClient = this.clients.THOR;
+            if (!chainClient || !thorClient) {
+                throw Error('Can not find a wallet client');
+            }
+            const thornameDetail = yield this.thorchainQuery.getThornameDetails(params.thorname);
+            if ((thornameDetail === null || thornameDetail === void 0 ? void 0 : thornameDetail.owner) !== thorClient.getAddress()) {
+                throw Error('You cannot update a domain that is not yours');
+            }
+            const thornameEstimation = yield this.thorchainQuery.estimateThorname(Object.assign(Object.assign({}, params), { chain: params.chain || xchainBitcoin.BTCChain, isUpdate: true, preferredAsset: params.preferredAsset || xchainUtil.assetFromString(thornameDetail.preferredAsset), chainAddress: params.chainAddress || chainClient.getAddress() }));
+            const castedThorClient = thorClient;
+            const result = yield castedThorClient.deposit({
+                asset: thornameEstimation.value.asset,
+                amount: thornameEstimation.value.baseAmount,
+                memo: thornameEstimation.memo,
+            });
+            return result;
+        });
+    }
     /** Function handles liquidity add for all non rune assets
      *
      * @param params - parameters for add liquidity
@@ -920,6 +981,16 @@ class ThorchainAMM {
             });
         });
     }
+    /**
+     * Get all Thornames and its data associated owned by an address
+     * @param address - address
+     * @returns thornames data
+     */
+    getThornamesByAddress(address) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.thorchainQuery.thorchainCache.midgardQuery.midgardCache.midgard.getTHORNameReverseLookup(address);
+        });
+    }
 }
 
 exports.ThorchainAMM = ThorchainAMM;

package/lib/thorchain-amm.d.ts

@@ -120,4 +120,10 @@ export declare class ThorchainAMM {
      * @returns
      */
     withdrawLoan(wallet: Wallet, loanCloseParams: LoanCloseParams): Promise<TxSubmitted>;
+    /**
+     * Get all Thornames and its data associated owned by an address
+     * @param address - address
+     * @returns thornames data
+     */
+    getThornamesByAddress(address: string): Promise<import("@xchainjs/xchain-midgard/lib").ReverseTHORNames | undefined>;
 }

package/lib/types.d.ts

@@ -56,3 +56,19 @@ export type LoanCloseParams = {
     amount: CryptoAmount;
     toAddress: Address;
 };
+export type RegisterThornameParams = {
+    thorname: string;
+    owner?: string;
+    chain?: string;
+    chainAddress?: string;
+    preferredAsset?: Asset;
+    expirity?: Date;
+};
+export type UpdateThornameParams = {
+    thorname: string;
+    owner?: string;
+    chain?: string;
+    chainAddress?: string;
+    preferredAsset?: Asset;
+    expirity?: Date;
+};

package/lib/wallet.d.ts

@@ -1,7 +1,7 @@
 import { Network, XChainClient } from '@xchainjs/xchain-client';
 import { CryptoAmount, ThorchainQuery } from '@xchainjs/xchain-thorchain-query';
 import { Address } from '@xchainjs/xchain-util';
-import { AddLiquidity, AllBalances, ExecuteSwap, LoanCloseParams, LoanOpenParams, TxSubmitted, WithdrawLiquidity } from './types';
+import { AddLiquidity, AllBalances, ExecuteSwap, LoanCloseParams, LoanOpenParams, RegisterThornameParams, TxSubmitted, UpdateThornameParams, WithdrawLiquidity } from './types';
 import { EvmHelper } from './utils/evm-helper';
 export type NodeUrls = Record<Network, string>;
 /**
@@ -81,6 +81,31 @@ export declare class Wallet {
     withdrawSavers(assetAmount: CryptoAmount, memo: string, toAddress: Address): Promise<TxSubmitted>;
     loanOpen(params: LoanOpenParams): Promise<TxSubmitted>;
     loanClose(params: LoanCloseParams): Promise<TxSubmitted>;
+    /**
+     * Register a THORName with a default expirity of one year. By default chain and chainAddress is getting from wallet instance and is BTC.
+     * By default owner is getting from wallet
+     * @param thorname - Name to register
+     * @param chain - Chain to add alias
+     * @param chainAddress - Address to add to chain alias
+     * @param owner - Owner address (rune address)
+     * @param preferredAsset - referred asset
+     * @param expirity - expirity of the domain in MILLISECONDS
+     * @param isUpdate - true only if the domain is already register and you want to update its data
+     * @returns memo and value of deposit
+     */
+    registerThorname(params: RegisterThornameParams): Promise<string>;
+    /**
+     * Register a THORName with a default expirity of one year. By default chain and chainAddress is getting from wallet instance and is BTC.
+     * By default owner is getting from wallet
+     * @param thorname - Name to register
+     * @param chain - Chain to add alias
+     * @param chainAddress - Address to add to chain alias
+     * @param owner - Owner address (rune address)
+     * @param preferredAsset - referred asset
+     * @param expirity - expirity of the domain in MILLISECONDS
+     * @returns memo and value of deposit
+     */
+    updateThorname(params: UpdateThornameParams): Promise<string>;
     /** Function handles liquidity add for all non rune assets
      *
      * @param params - parameters for add liquidity

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xchainjs/xchain-thorchain-amm",
-  "version": "0.7.0",
+  "version": "0.7.2",
   "description": "module that exposes estimating & swappping cryptocurrency assets on thorchain",
   "keywords": [
     "THORChain",
@@ -55,7 +55,7 @@
     "@xchainjs/xchain-midgard": "^0.5.1",
     "@xchainjs/xchain-thorchain": "^0.28.6",
     "@xchainjs/xchain-thornode": "^0.3.6",
-    "@xchainjs/xchain-thorchain-query": "^0.6.0",
+    "@xchainjs/xchain-thorchain-query": "^0.6.2",
     "@xchainjs/xchain-util": "^0.13.1",
     "@xchainjs/xchain-utxo-providers": "^0.2.2",
     "axios": "^1.3.6",
@@ -91,7 +91,7 @@
     "@xchainjs/xchain-midgard": "^0.5.1",
     "@xchainjs/xchain-thorchain": "^0.28.6",
     "@xchainjs/xchain-thornode": "^0.3.6",
-    "@xchainjs/xchain-thorchain-query": "^0.6.0",
+    "@xchainjs/xchain-thorchain-query": "^0.6.2",
     "@xchainjs/xchain-util": "^0.13.1",
     "@xchainjs/xchain-utxo-providers": "^0.2.2",
     "axios": "^1.3.6",