@xchainjs/xchain-mayachain-amm 2.0.11 → 2.0.12

package/README.md

@@ -1,70 +1,73 @@
-# `@xchainjs/xchain-mayachain-amm`
+<div align="center">
+  <h1 align="center">MAYAChain AMM</h1>
 
-## Modules
+  <p align="center">
+    <a href='https://www.npmjs.com/package/@xchainjs/xchain-mayachain-amm' target='_blank'>
+      <img alt="NPM Version" src="https://img.shields.io/npm/v/%40xchainjs%2Fxchain-mayachain-amm" />
+    </a>
+      <a href='https://www.npmjs.com/package/@xchainjs/xchain-mayachain-amm' target='_blank'>
+      <img alt="NPM Downloads" src="https://img.shields.io/npm/d18m/%40xchainjs%2Fxchain-mayachain-amm" />
+    </a>
+  </p>
+</div>
 
-Mayachain AMM module
+<br />
+
+
+MAYAChain AMM is a module that allows users and developers to interact with the MAYAChain protocol without having to worry about the underlining particularities of the protocol.
 
 ## Installation
 
-```
+```sh
 yarn add @xchainjs/xchain-mayachain-amm
 ```
 
-Following peer dependencies have to be installed into your project. These are not included in `@xchainjs/xchain-mayachain-amm`.
-
-```bash
-  "dependencies": {
-    "@cosmos-client/core": "0.46.1",
-    "@psf/bitcoincashjs-lib": "^4.0.3",
-    "@xchainjs/xchain-bitcoin": "^0.23.6",
-    "@xchainjs/xchain-client": "^0.15.4",
-    "@xchainjs/xchain-cosmos-sdk": "^0.1.3",
-    "@xchainjs/xchain-crypto": "^0.3.0",
-    "@xchainjs/xchain-dash": "^0.2.5",
-    "@xchainjs/xchain-ethereum": "^0.31.1",
-    "@xchainjs/xchain-mayanode": "^0.1.2",
-    "@xchainjs/xchain-mayachain-query": "^0.1.0",
-    "@xchainjs/xchain-evm": "^0.4.1",
-    "@xchainjs/xchain-kujira": "^0.1.2",
-    "@xchainjs/xchain-mayachain": "^0.2.10",
-    "@xchainjs/xchain-mayamidgard": "^0.1.0",
-    "@xchainjs/xchain-thorchain": "^0.28.13",
-    "@xchainjs/xchain-util": "^0.13.1",
-    "@xchainjs/xchain-utxo-providers": "^0.2.8",
-    "axios": "^1.3.6",
-    "axios-retry": "^3.2.5",
-    "bignumber.js": "^9.0.0",
-    "bitcoinjs-lib": "5.2.0",
-    "coininfo": "^5.1.0",
-    "coinselect": "^3.1.12",
-    "dotenv": "^16.0.0",
-    "ethers": "^5.6.6",
-    "wif": "^2.0.6"
-  }
+or 
 
-```
+```sh
+npm install @xchainjs/xchain-mayachain-amm
 
-## For live examples
+```
 
+## Initialization
 
-## Documentation
+Using Mayachain AMM, you can initialize the main class of the module in consultation mode if you do not provide any parameters, this means you could retrieve information from the protocol, but you will not be able to make actions the protocol needs you to sign.
 
+```ts
+  import { MayachainAMM } from '@xchainjs/xchain-mayachain-amm'
 
-## Compiler options
+  const mayachainAmm = new MayachainAMM()
+```
 
-tsconfig compiler options
+Otherwise, if you want to be able make actions the protocol needs you to sign, you will need to initialize the main class of the protocol as follows
 
 ```ts
-{
-    "compilerOptions": {
-        "module":"commonjs",
-        "target": "es5",
-        "noEmitOnError": true,
-        "resolveJsonModule": true,
-        "esModuleInterop": true,
-        "lib": ["es6", "dom", "es2016", "es2017"]
-    }
-}
+  import { MayachainAMM } from '@xchainjs/xchain-mayachain-amm'
+  import { MayachainQuery } from '@xchainjs/xchain-mayachain-query'
+  import { Wallet } from '@xchainjs/xchain-wallet'
+
+  const mayaChainQuery = new MayachainQuery()
+  const wallet = new Wallet({
+    // Your XChainJS clients
+  })
+  const mayachainAmm = new MayachainAMM(mayaChainQuery, wallet)
 ```
 
-### Setting environment variables
+## Features
+
+Using MAYAChain AMM package, you could easily implement the following features
+
+### Swaps
+
+- Estimate swaps
+- Do swaps
+- Approve MAYAChain router to spend to be able to do ERC-20 swaps
+
+### MAYANames
+
+- Get MAYAName details
+- Get MAYANames by owner
+
+## Examples
+
+You can find examples using the MAYAChain AMM package in the [mayachain-amm](https://github.com/xchainjs/xchainjs-lib/tree/master/examples/mayachain-amm) examples folder.

package/lib/index.esm.js

@@ -7,7 +7,7 @@ import 'crypto';
 import require$$0$4$1 from 'buffer';
 import { ethers } from 'ethers';
 import { KUJIChain, Client as Client$2, defaultKujiParams, AssetKUJI } from '@xchainjs/xchain-kujira';
-import { MAYAChain, Client } from '@xchainjs/xchain-mayachain';
+import { MAYAChain, Client, AssetCacao, CACAO_DECIMAL } from '@xchainjs/xchain-mayachain';
 import { MayachainQuery } from '@xchainjs/xchain-mayachain-query';
 import { THORChain, Client as Client$1, AssetRuneNative } from '@xchainjs/xchain-thorchain';
 import { Wallet as Wallet$1 } from '@xchainjs/xchain-wallet';
@@ -89870,6 +89870,119 @@ class MayachainAMM {
             return this.mayachainQuery.getMAYANamesByOwner(owner);
         });
     }
+    /**
+     * Estimate the cost of a MAYAName registration
+     * @param {RegisterMAYAName} params Params to make the registration
+     * @returns {QuoteMAYAName} Memo to make the registration and the estimation of the operation
+     */
+    estimateMAYANameRegistration(params) {
+        return __awaiter$8(this, void 0, void 0, function* () {
+            const errors = [];
+            if (!validateAddress(this.mayachainQuery.getNetwork(), params.chain, params.chainAddress)) {
+                errors.push(`Invalid address ${params.chainAddress} for ${params.chain} chain`);
+            }
+            if (!validateAddress(this.mayachainQuery.getNetwork(), MAYAChain, params.owner)) {
+                errors.push(`Invalid owner ${params.owner} due it is not a MAYAChain address`);
+            }
+            if (errors.length) {
+                return {
+                    memo: '',
+                    errors,
+                    value: new CryptoAmount(baseAmount(0, CACAO_DECIMAL), AssetCacao),
+                    allowed: false,
+                };
+            }
+            try {
+                const estimated = yield this.mayachainQuery.estimateMAYAName(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, CACAO_DECIMAL), AssetCacao),
+                    allowed: false,
+                };
+            }
+        });
+    }
+    /**
+     * Estimate the cost of an update of a MAYAName
+     * @param {QuoteMAYANameParams} params Params to make the update
+     * @returns {QuoteMAYAName} Memo to make the update and the estimation of the operation
+     */
+    estimateMAYANameUpdate(params) {
+        return __awaiter$8(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.mayachainQuery.getNetwork(), params.chain, params.chainAddress)) {
+                errors.push(`Invalid alias ${params.chainAddress} for ${params.chain} chain`);
+            }
+            if (params.owner && !validateAddress(this.mayachainQuery.getNetwork(), MAYAChain, params.owner)) {
+                errors.push(`Invalid owner ${params.owner} due it is not a MAYAChain address`);
+            }
+            if (errors.length) {
+                return {
+                    memo: '',
+                    errors,
+                    value: new CryptoAmount(baseAmount(0, CACAO_DECIMAL), AssetCacao),
+                    allowed: false,
+                };
+            }
+            try {
+                const estimated = yield this.mayachainQuery.estimateMAYAName(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, CACAO_DECIMAL), AssetCacao),
+                    allowed: false,
+                };
+            }
+        });
+    }
+    /**
+     * Register a MAYAName
+     * @param {RegisterMAYAName} params Params to make the registration
+     * @returns {QuoteMAYAName} Memo to make the update or the registration and the estimation of the operation
+     */
+    registerMAYAName(params) {
+        return __awaiter$8(this, void 0, void 0, function* () {
+            const quote = yield this.estimateMAYANameRegistration(params);
+            if (!quote.allowed)
+                throw Error(`Can not register MAYAName. ${quote.errors.join(' ')}`);
+            return MayachainAction.makeAction({
+                wallet: this.wallet,
+                assetAmount: quote.value,
+                memo: quote.memo,
+            });
+        });
+    }
+    /**
+     * Update a MAYAName
+     * @param {QuoteMAYANameParams} params Params to make the update
+     * @returns {QuoteMAYAName} Memo to make the update or the registration and the estimation of the operation
+     */
+    updateMAYAName(params) {
+        return __awaiter$8(this, void 0, void 0, function* () {
+            const quote = yield this.estimateMAYANameUpdate(params);
+            if (!quote.allowed)
+                throw Error(`Can not update MAYAName. ${quote.errors.join(' ')}`);
+            return MayachainAction.makeAction({
+                wallet: this.wallet,
+                assetAmount: quote.value,
+                memo: quote.memo,
+            });
+        });
+    }
     /**
      * Check if a name is a valid MAYAName
      * @param {string} name MAYAName to check

package/lib/index.js

@@ -89878,6 +89878,119 @@ class MayachainAMM {
             return this.mayachainQuery.getMAYANamesByOwner(owner);
         });
     }
+    /**
+     * Estimate the cost of a MAYAName registration
+     * @param {RegisterMAYAName} params Params to make the registration
+     * @returns {QuoteMAYAName} Memo to make the registration and the estimation of the operation
+     */
+    estimateMAYANameRegistration(params) {
+        return __awaiter$8(this, void 0, void 0, function* () {
+            const errors = [];
+            if (!validateAddress(this.mayachainQuery.getNetwork(), params.chain, params.chainAddress)) {
+                errors.push(`Invalid address ${params.chainAddress} for ${params.chain} chain`);
+            }
+            if (!validateAddress(this.mayachainQuery.getNetwork(), xchainMayachain.MAYAChain, params.owner)) {
+                errors.push(`Invalid owner ${params.owner} due it is not a MAYAChain address`);
+            }
+            if (errors.length) {
+                return {
+                    memo: '',
+                    errors,
+                    value: new CryptoAmount(baseAmount(0, xchainMayachain.CACAO_DECIMAL), xchainMayachain.AssetCacao),
+                    allowed: false,
+                };
+            }
+            try {
+                const estimated = yield this.mayachainQuery.estimateMAYAName(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, xchainMayachain.CACAO_DECIMAL), xchainMayachain.AssetCacao),
+                    allowed: false,
+                };
+            }
+        });
+    }
+    /**
+     * Estimate the cost of an update of a MAYAName
+     * @param {QuoteMAYANameParams} params Params to make the update
+     * @returns {QuoteMAYAName} Memo to make the update and the estimation of the operation
+     */
+    estimateMAYANameUpdate(params) {
+        return __awaiter$8(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.mayachainQuery.getNetwork(), params.chain, params.chainAddress)) {
+                errors.push(`Invalid alias ${params.chainAddress} for ${params.chain} chain`);
+            }
+            if (params.owner && !validateAddress(this.mayachainQuery.getNetwork(), xchainMayachain.MAYAChain, params.owner)) {
+                errors.push(`Invalid owner ${params.owner} due it is not a MAYAChain address`);
+            }
+            if (errors.length) {
+                return {
+                    memo: '',
+                    errors,
+                    value: new CryptoAmount(baseAmount(0, xchainMayachain.CACAO_DECIMAL), xchainMayachain.AssetCacao),
+                    allowed: false,
+                };
+            }
+            try {
+                const estimated = yield this.mayachainQuery.estimateMAYAName(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, xchainMayachain.CACAO_DECIMAL), xchainMayachain.AssetCacao),
+                    allowed: false,
+                };
+            }
+        });
+    }
+    /**
+     * Register a MAYAName
+     * @param {RegisterMAYAName} params Params to make the registration
+     * @returns {QuoteMAYAName} Memo to make the update or the registration and the estimation of the operation
+     */
+    registerMAYAName(params) {
+        return __awaiter$8(this, void 0, void 0, function* () {
+            const quote = yield this.estimateMAYANameRegistration(params);
+            if (!quote.allowed)
+                throw Error(`Can not register MAYAName. ${quote.errors.join(' ')}`);
+            return MayachainAction.makeAction({
+                wallet: this.wallet,
+                assetAmount: quote.value,
+                memo: quote.memo,
+            });
+        });
+    }
+    /**
+     * Update a MAYAName
+     * @param {QuoteMAYANameParams} params Params to make the update
+     * @returns {QuoteMAYAName} Memo to make the update or the registration and the estimation of the operation
+     */
+    updateMAYAName(params) {
+        return __awaiter$8(this, void 0, void 0, function* () {
+            const quote = yield this.estimateMAYANameUpdate(params);
+            if (!quote.allowed)
+                throw Error(`Can not update MAYAName. ${quote.errors.join(' ')}`);
+            return MayachainAction.makeAction({
+                wallet: this.wallet,
+                assetAmount: quote.value,
+                memo: quote.memo,
+            });
+        });
+    }
     /**
      * Check if a name is a valid MAYAName
      * @param {string} name MAYAName to check

package/lib/mayachain-amm.d.ts

@@ -1,7 +1,7 @@
-import { MAYANameDetails, MayachainQuery, QuoteSwap, QuoteSwapParams } from '@xchainjs/xchain-mayachain-query';
+import { MAYANameDetails, MayachainQuery, QuoteSwap, QuoteSwapParams, RegisterMAYAName, UpdateMAYAName } from '@xchainjs/xchain-mayachain-query';
 import { Address } from '@xchainjs/xchain-util';
 import { Wallet } from '@xchainjs/xchain-wallet';
-import { ApproveParams, IsApprovedParams, TxSubmitted } from './types';
+import { ApproveParams, IsApprovedParams, QuoteMAYAName, TxSubmitted } from './types';
 /**
  * Mayachain Automated Market Maker (AMM) class.
  * MAYAChainAMM class for interacting with THORChain.
@@ -63,6 +63,30 @@ export declare class MayachainAMM {
      * @returns {MAYANameDetails[]} List of MAYANames owned by the address
      */
     getMAYANamesByOwner(owner: Address): Promise<MAYANameDetails[]>;
+    /**
+     * Estimate the cost of a MAYAName registration
+     * @param {RegisterMAYAName} params Params to make the registration
+     * @returns {QuoteMAYAName} Memo to make the registration and the estimation of the operation
+     */
+    estimateMAYANameRegistration(params: RegisterMAYAName): Promise<QuoteMAYAName>;
+    /**
+     * Estimate the cost of an update of a MAYAName
+     * @param {QuoteMAYANameParams} params Params to make the update
+     * @returns {QuoteMAYAName} Memo to make the update and the estimation of the operation
+     */
+    estimateMAYANameUpdate(params: UpdateMAYAName): Promise<QuoteMAYAName>;
+    /**
+     * Register a MAYAName
+     * @param {RegisterMAYAName} params Params to make the registration
+     * @returns {QuoteMAYAName} Memo to make the update or the registration and the estimation of the operation
+     */
+    registerMAYAName(params: RegisterMAYAName): Promise<TxSubmitted>;
+    /**
+     * Update a MAYAName
+     * @param {QuoteMAYANameParams} params Params to make the update
+     * @returns {QuoteMAYAName} Memo to make the update or the registration and the estimation of the operation
+     */
+    updateMAYAName(params: UpdateMAYAName): Promise<TxSubmitted>;
     /**
      * Check if a name is a valid MAYAName
      * @param {string} name MAYAName to check

package/lib/types.d.ts

@@ -1,3 +1,4 @@
+import { QuoteMAYAName as BaseQuoteMAYAName } from '@xchainjs/xchain-mayachain-query';
 import { Address, Asset, CryptoAmount } from '@xchainjs/xchain-util';
 export type TxSubmitted = {
     hash: string;
@@ -12,3 +13,16 @@ export type IsApprovedParams = {
     amount: CryptoAmount;
     address: Address;
 };
+/**
+ * MAYAName quote parameters
+ */
+export type QuoteMAYAName = BaseQuoteMAYAName & {
+    /**
+     * 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-mayachain-amm",
-  "version": "2.0.11",
+  "version": "2.0.12",
   "description": "module that exposes estimating & swapping cryptocurrency assets on mayachain",
   "keywords": [
     "MAYAChain",
@@ -43,7 +43,7 @@
     "@xchainjs/xchain-ethereum": "0.32.6",
     "@xchainjs/xchain-kujira": "0.1.21",
     "@xchainjs/xchain-mayachain": "1.0.11",
-    "@xchainjs/xchain-mayachain-query": "0.1.18",
+    "@xchainjs/xchain-mayachain-query": "0.1.19",
     "@xchainjs/xchain-thorchain": "1.1.1",
     "@xchainjs/xchain-wallet": "0.1.19",
     "ethers": "5.7.2"