@pioneer-platform/osmosis-client 0.0.15 → 0.1.0

package/CHANGELOG.md

@@ -0,0 +1,16 @@
+# @pioneer-platform/osmosis-client
+
+## 0.1.0
+
+### Minor Changes
+
+- Release: minor version bump for all packages
+
+### Patch Changes
+
+- Updated dependencies
+  - @pioneer-platform/cosmos-network@8.4.0
+  - @pioneer-platform/osmosis-network@8.4.0
+  - @pioneer-platform/loggerdog@8.4.0
+  - @pioneer-platform/pioneer-coins@9.4.0
+  - @pioneer-platform/pioneer-caip@9.3.0

package/lib/index.js

@@ -1,56 +1,19 @@
-"use strict";
 /*
     Osmosis Swap Intergration
                 -Highlander
 
  */
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-var __generator = (this && this.__generator) || function (thisArg, body) {
-    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
-    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
-    function verb(n) { return function (v) { return step([n, v]); }; }
-    function step(op) {
-        if (f) throw new TypeError("Generator is already executing.");
-        while (g && (g = 0, op[0] && (_ = 0)), _) try {
-            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
-            if (y = 0, t) op = [op[0] & 2, t.value];
-            switch (op[0]) {
-                case 0: case 1: t = op; break;
-                case 4: _.label++; return { value: op[1], done: false };
-                case 5: _.label++; y = op[1]; op = [0]; continue;
-                case 7: op = _.ops.pop(); _.trys.pop(); continue;
-                default:
-                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
-                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
-                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
-                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
-                    if (t[2]) _.ops.pop();
-                    _.trys.pop(); continue;
-            }
-            op = body.call(thisArg, _);
-        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
-        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
-    }
-};
-var TAG = " | osmosis | ";
-var log = require('@pioneer-platform/loggerdog')();
-var _a = require("@pioneer-platform/pioneer-caip"), caipToNetworkId = _a.caipToNetworkId, shortListSymbolToCaip = _a.shortListSymbolToCaip, ChainToNetworkId = _a.ChainToNetworkId;
-var networkOsmo = require("@pioneer-platform/osmosis-network");
-var networkAtom = require("@pioneer-platform/cosmos-network");
-var uuid = require('uuidv4').uuid;
-var networkSupport = [
+const TAG = " | osmosis | ";
+const log = require('@pioneer-platform/loggerdog')();
+let { caipToNetworkId, shortListSymbolToCaip, ChainToNetworkId } = require("@pioneer-platform/pioneer-caip");
+let networkOsmo = require("@pioneer-platform/osmosis-network");
+let networkAtom = require("@pioneer-platform/cosmos-network");
+const { uuid } = require('uuidv4');
+let networkSupport = [
     ChainToNetworkId["OSMO"],
     ChainToNetworkId["GAIA"],
 ];
-var assetSupport = [
+let assetSupport = [
     shortListSymbolToCaip["OSMO"],
     shortListSymbolToCaip["GAIA"],
 ];
@@ -70,145 +33,143 @@ module.exports = {
 };
 function quoteFromPool(amountAtomSwap, amountAtomPool, amountOsmoPool, maxSlippage) {
     // Convert string inputs to numbers and scale the swap amount
-    var swapAmount = parseFloat(amountAtomSwap) * 1e6;
-    var atomPoolAmount = parseFloat(amountAtomPool);
-    var osmoPoolAmount = parseFloat(amountOsmoPool);
+    const swapAmount = parseFloat(amountAtomSwap) * 1e6;
+    const atomPoolAmount = parseFloat(amountAtomPool);
+    const osmoPoolAmount = parseFloat(amountOsmoPool);
     // Calculate the constant product
-    var k = atomPoolAmount * osmoPoolAmount;
+    const k = atomPoolAmount * osmoPoolAmount;
     // New amount of ATOM in the pool after the swap
-    var newAtomPoolAmount = atomPoolAmount + swapAmount;
+    const newAtomPoolAmount = atomPoolAmount + swapAmount;
     // Calculate the amount of OSMO received
-    var newOsmoPoolAmount = k / newAtomPoolAmount;
-    var osmoReceived = osmoPoolAmount - newOsmoPoolAmount;
+    const newOsmoPoolAmount = k / newAtomPoolAmount;
+    const osmoReceived = osmoPoolAmount - newOsmoPoolAmount;
     // Scale back down the amount of OSMO received
-    var scaledOsmoReceived = osmoReceived / 1e6;
+    const scaledOsmoReceived = osmoReceived / 1e6;
     // Calculate the actual rate of the swap
-    var actualRate = scaledOsmoReceived / (swapAmount / 1e6);
+    const actualRate = scaledOsmoReceived / (swapAmount / 1e6);
     // Calculate the ideal rate
-    var idealRate = osmoPoolAmount / atomPoolAmount;
+    const idealRate = osmoPoolAmount / atomPoolAmount;
     // Calculate the slippage
-    var slippage = ((idealRate - actualRate) / idealRate) * 100;
+    const slippage = ((idealRate - actualRate) / idealRate) * 100;
     // Calculate amountOutMin considering the maximum slippage
-    var amountOutMin = scaledOsmoReceived * (1 - maxSlippage / 100);
+    const amountOutMin = scaledOsmoReceived * (1 - maxSlippage / 100);
     return {
         amountOutMin: amountOutMin.toFixed(6).toString(),
         amountOut: scaledOsmoReceived.toFixed(6),
         slippage: Math.max(slippage, 0).toFixed(6)
     };
 }
-var get_quote = function (quote) {
-    return __awaiter(this, void 0, void 0, function () {
-        var tag, output, pools, amountAtom, amountOsmo, rate, invocationId, result, tx1, tx2, tx1, tx2, e_1;
-        return __generator(this, function (_a) {
-            switch (_a.label) {
-                case 0:
-                    tag = TAG + " | get_quote | ";
-                    _a.label = 1;
-                case 1:
-                    _a.trys.push([1, 3, , 4]);
-                    output = {};
-                    if (!quote.sellAsset)
-                        throw new Error("missing sellAsset");
-                    if (!quote.buyAsset)
-                        throw new Error("missing buyAsset");
-                    if (!quote.sellAmount)
-                        throw new Error("missing sellAmount");
-                    if (!quote.senderAddress)
-                        throw new Error("missing senderAddress");
-                    if (!quote.recipientAddress)
-                        throw new Error("missing recipientAddress");
-                    if (!quote.slippage)
-                        throw new Error("missing slippage");
-                    return [4 /*yield*/, networkOsmo.getPools()];
-                case 2:
-                    pools = _a.sent();
-                    if (!pools.pools[0])
-                        throw Error("Unable to get pools from network!");
-                    log.info(tag, "resp: ", pools.pools[0].pool_assets);
-                    amountAtom = pools.pools[0].pool_assets[0].token.amount;
-                    amountOsmo = pools.pools[0].pool_assets[1].token.amount;
-                    rate = amountOsmo / amountAtom;
-                    output.rate = rate;
-                    log.info(tag, "rate: ", rate);
-                    invocationId = uuid();
-                    output.invocationId = invocationId;
-                    output.meta = {
-                        quoteMode: "OSMOSIS-IBC"
-                    };
-                    // get amountOut
-                    //2 steps
-                    output.steps = 2;
-                    output.complete = true;
-                    result = void 0;
-                    if (quote.sellAsset === shortListSymbolToCaip["OSMO"]) {
-                        result = quoteFromPool(quote.sellAmount, amountAtom, amountOsmo, quote.slippage);
-                        if (!result || !result.amountOut)
-                            throw new Error("Unable to get result from quoteFromPool");
-                        output.amountOut = result.amountOut;
-                        output.result = result;
-                        tx1 = {
-                            type: "sendSwapTx",
-                            chain: caipToNetworkId(shortListSymbolToCaip["OSMO"]),
-                            txParams: {
-                                senderAddress: quote.senderAddress,
-                                tokenIn: 'uosmo',
-                                tokenOut: 'ibc/27394FB092D2ECCD56123C74F36E4C1F926001CEADA9CA97EA622B25F41E5EB2',
-                                amountIn: quote.sellAmount,
-                                amountOutMin: result.amountOutMin,
-                            }
-                        };
-                        log.info(tag, "tx1: ", tx1);
-                        tx2 = {
-                            type: "ibcTransfer",
-                            chain: caipToNetworkId(shortListSymbolToCaip["ATOM"]), // Assuming ATOM is the target chain for the IBC withdrawal
-                            txParams: {
-                                senderAddress: quote.senderAddress, // Address initiating the IBC withdrawal
-                                recipientAddress: quote.recipientAddress, // Destination address for the ATOM tokens
-                                amount: result.amountOut, // Amount of ATOM tokens to withdraw
-                                token: 'uatom' // Other parameters required for the IBC withdrawal can be added here
-                            }
-                        };
-                        log.info(tag, "tx2: ", tx2);
-                        output.txs = [tx1, tx2];
-                    }
-                    else if (quote.sellAsset === shortListSymbolToCaip["ATOM"]) {
-                        result = quoteFromPool(quote.sellAmount, amountAtom, amountOsmo, quote.slippage);
-                        output.result = result;
-                        tx1 = {
-                            type: "ibcTransfer",
-                            chain: shortListSymbolToCaip["ATOM"],
-                            txParams: {
-                                senderAddress: quote.senderAddress, // Address initiating the IBC deposit
-                                recipientAddress: quote.recipientAddress, // Osmosis address to receive ATOM
-                                amount: quote.sellAmount, // Amount of ATOM tokens to deposit
-                                // Other parameters for the IBC deposit can be added here
-                            }
-                        };
-                        log.info(tag, "tx1: ", tx1);
-                        tx2 = {
-                            type: "sendSwapTx",
-                            chain: shortListSymbolToCaip["OSMO"],
-                            txParams: {
-                                senderAddress: quote.senderAddress,
-                                sellAsset: shortListSymbolToCaip["ATOM"],
-                                buyAsset: quote.buyAsset,
-                                sellAmount: result.amountOut, // Amount of ATOM obtained from the IBC deposit
-                                buyAmountMin: quote.sellAmount // Minimum amount of OSMO to buy
-                            }
-                        };
-                        log.info(tag, "tx2: ", tx2);
-                        output.txs = [tx1, tx2];
-                    }
-                    else {
-                        throw Error("Asset not supported! asset:" + quote.sellAsset);
-                    }
-                    return [2 /*return*/, output];
-                case 3:
-                    e_1 = _a.sent();
-                    console.error(tag, "e: ", e_1);
-                    return [3 /*break*/, 4];
-                case 4: return [2 /*return*/];
-            }
-        });
-    });
+const get_quote = async function (quote) {
+    let tag = TAG + " | get_quote | ";
+    try {
+        let output = {};
+        if (!quote.sellAsset)
+            throw new Error("missing sellAsset");
+        if (!quote.buyAsset)
+            throw new Error("missing buyAsset");
+        if (!quote.sellAmount)
+            throw new Error("missing sellAmount");
+        if (!quote.senderAddress)
+            throw new Error("missing senderAddress");
+        if (!quote.recipientAddress)
+            throw new Error("missing recipientAddress");
+        if (!quote.slippage)
+            throw new Error("missing slippage");
+        //get pools
+        let pools = await networkOsmo.getPools();
+        if (!pools.pools[0])
+            throw Error("Unable to get pools from network!");
+        log.info(tag, "resp: ", pools.pools[0].pool_assets);
+        let amountAtom = pools.pools[0].pool_assets[0].token.amount; // ATOM amount
+        let amountOsmo = pools.pools[0].pool_assets[1].token.amount; // OSMO amount
+        let rate = amountOsmo / amountAtom;
+        output.rate = rate;
+        log.info(tag, "rate: ", rate);
+        //issue invocationId
+        let invocationId = uuid();
+        output.invocationId = invocationId;
+        output.source = 'osmosis';
+        output.meta = {
+            quoteMode: "OSMOSIS-IBC"
+        };
+        // get amountOut
+        //2 steps
+        output.steps = 2;
+        output.complete = true;
+        let result;
+        if (quote.sellAsset === shortListSymbolToCaip["OSMO"]) {
+            result = quoteFromPool(quote.sellAmount, amountAtom, amountOsmo, quote.slippage);
+            if (!result || !result.amountOut)
+                throw new Error("Unable to get result from quoteFromPool");
+            output.amountOut = result.amountOut;
+            output.result = result;
+            //build first TX
+            //swap osmo for Atom IBC
+            let tx1 = {
+                type: "sendSwapTx",
+                chain: caipToNetworkId(shortListSymbolToCaip["OSMO"]),
+                txParams: {
+                    senderAddress: quote.senderAddress,
+                    tokenIn: 'uosmo',
+                    tokenOut: 'ibc/27394FB092D2ECCD56123C74F36E4C1F926001CEADA9CA97EA622B25F41E5EB2',
+                    amountIn: quote.sellAmount,
+                    amountOutMin: result.amountOutMin,
+                }
+            };
+            log.info(tag, "tx1: ", tx1);
+            //get balance ibc?
+            //IBC withdrawal from osmo:atom to atom
+            let tx2 = {
+                type: "ibcTransfer",
+                chain: caipToNetworkId(shortListSymbolToCaip["ATOM"]), // Assuming ATOM is the target chain for the IBC withdrawal
+                txParams: {
+                    senderAddress: quote.senderAddress, // Address initiating the IBC withdrawal
+                    recipientAddress: quote.recipientAddress, // Destination address for the ATOM tokens
+                    amount: result.amountOut, // Amount of ATOM tokens to withdraw
+                    token: 'uatom' // Other parameters required for the IBC withdrawal can be added here
+                }
+            };
+            log.info(tag, "tx2: ", tx2);
+            output.txs = [tx1, tx2];
+        }
+        else if (quote.sellAsset === shortListSymbolToCaip["ATOM"]) {
+            result = quoteFromPool(quote.sellAmount, amountAtom, amountOsmo, quote.slippage);
+            output.result = result;
+            //TODO audit this
+            //deposit atom to osmo:atom IBC
+            // Deposit ATOM to osmo:atom IBC
+            let tx1 = {
+                type: "ibcTransfer",
+                chain: shortListSymbolToCaip["ATOM"],
+                txParams: {
+                    senderAddress: quote.senderAddress, // Address initiating the IBC deposit
+                    recipientAddress: quote.recipientAddress, // Osmosis address to receive ATOM
+                    amount: quote.sellAmount, // Amount of ATOM tokens to deposit
+                    // Other parameters for the IBC deposit can be added here
+                }
+            };
+            log.info(tag, "tx1: ", tx1);
+            // Swap ATOM for OSMO
+            let tx2 = {
+                type: "sendSwapTx",
+                chain: shortListSymbolToCaip["OSMO"],
+                txParams: {
+                    senderAddress: quote.senderAddress,
+                    sellAsset: shortListSymbolToCaip["ATOM"],
+                    buyAsset: quote.buyAsset,
+                    sellAmount: result.amountOut, // Amount of ATOM obtained from the IBC deposit
+                    buyAmountMin: quote.sellAmount // Minimum amount of OSMO to buy
+                }
+            };
+            log.info(tag, "tx2: ", tx2);
+            output.txs = [tx1, tx2];
+        }
+        else {
+            throw Error("Asset not supported! asset:" + quote.sellAsset);
+        }
+        return output;
+    }
+    catch (e) {
+        console.error(tag, "e: ", e);
+    }
 };

package/package.json

@@ -1,35 +1,35 @@
 {
   "name": "@pioneer-platform/osmosis-client",
-  "version": "0.0.15",
+  "version": "0.1.0",
   "main": "./lib/index.js",
   "types": "./lib/index.d.ts",
   "dependencies": {
-    "@pioneer-platform/cosmos-network": "^8.3.5",
-    "@pioneer-platform/loggerdog": "^8.3.1",
-    "@pioneer-platform/osmosis-network": "^8.3.11",
-    "@pioneer-platform/pioneer-caip": "^9.2.23",
-    "@pioneer-platform/pioneer-coins": "^9.2.13",
-    "axios": "^1.3.4",
+    "@pioneer-platform/cosmos-network": "^8.4.0",
+    "@pioneer-platform/loggerdog": "^8.4.0",
+    "@pioneer-platform/osmosis-network": "^8.4.0",
+    "@pioneer-platform/pioneer-caip": "^9.3.0",
+    "@pioneer-platform/pioneer-coins": "^9.4.0",
+    "axios": "^1.6.0",
     "dotenv": "^8.2.0",
     "rango-sdk": "^0.1.45",
     "uuidv4": "^6.2.13"
   },
-  "scripts": {
-    "npm": "npm i",
-    "test": "npm run build && node __tests__/test-module.js",
-    "build": "tsc -p .",
-    "prepublish": "npm run build",
-    "refresh": "rm -rf ./node_modules ./package-lock.json && npm install"
-  },
   "devDependencies": {
     "@types/jest": "^25.2.3",
-    "@types/node": "^13.13.21",
+    "@types/node": "^18.16.0",
     "@types/source-map-support": "^0.5.3",
     "jest": "^26.4.2",
     "onchange": "^7.0.2",
     "serve": "^11.3.2",
     "ts-jest": "^29.0.5",
-    "typescript": "^5.0.2"
+    "typescript": "^5.0.4"
   },
-  "gitHead": "a76012f6693a12181c4744e53e977a9eaeef0ed3"
-}
+  "gitHead": "a76012f6693a12181c4744e53e977a9eaeef0ed3",
+  "scripts": {
+    "npm": "pnpm i",
+    "test": "pnpm run build && node __tests__/test-module.js",
+    "build": "tsc -p .",
+    "prepublish": "pnpm run build",
+    "refresh": "rm -rf ./node_modules ./package-lock.json && pnpm install"
+  }
+}

package/tsconfig.json

@@ -1,13 +1,24 @@
 {
   "compilerOptions": {
-    "target": "es5",
+    "target": "es2020",
     "module": "commonjs",
-    "lib": ["es6", "es2015", "dom"],
+    "lib": ["es2020", "dom"],
     "declaration": true,
-    "outDir": "lib",
-    "rootDir": "src",
-    "strict": true,
-    "types": ["node"],
-    "esModuleInterop": true
-  }
+    "outDir": "./lib",
+    "rootDir": "./src",
+    "strict": false,
+    "noImplicitAny": false,
+    "strictNullChecks": false,
+    "strictFunctionTypes": false,
+    "strictBindCallApply": false,
+    "strictPropertyInitialization": false,
+    "noImplicitThis": false,
+    "alwaysStrict": false,
+    "esModuleInterop": true,
+    "resolveJsonModule": true,
+    "skipLibCheck": true,
+    "forceConsistentCasingInFileNames": true
+  },
+  "include": ["src"],
+  "exclude": ["node_modules", "**/__tests__/*"]
 }