rango-sdk-basic 0.0.1

package/README.md

@@ -0,0 +1,25 @@
+# Rango Exchange SDK (BETA)
+
+[![npm version](https://badge.fury.io/js/rango-sdk.svg)](https://badge.fury.io/js/rango-sdk)
+[![license](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://github.com/rango-exchange/rango-sdk/blob/master/LICENSE)
+
+
+This is the first phase of Rango SDK which only wraps Rest API calls. In the next phase, we will handle connecting to the wallet providers.
+
+> **WARNING:** The Rango SDK is still beta. Please use it on your own risk.
+
+> **WARNING:** The Rango SDK has not stabilized yet, and we might make some breaking changes.
+
+
+## Installation
+
+```shell
+  npm install rango-sdk --save
+```
+
+## Usage
+
+Please checkout the examples' folder for sample usage of the SDK. We will add more examples there soon.
+
+- [Documents](https://docs.rango.exchange/integration/overview)
+- [Examples](https://github.com/rango-exchange/rango-sdk/tree/master/examples/)

package/lib/index.d.ts

@@ -0,0 +1,3 @@
+export { RangoClient } from './services';
+export * from './types';
+//# sourceMappingURL=index.d.ts.map

package/lib/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAA;AACxC,cAAc,SAAS,CAAA"}

package/lib/index.js

@@ -0,0 +1,21 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RangoClient = void 0;
+var services_1 = require("./services");
+Object.defineProperty(exports, "RangoClient", { enumerable: true, get: function () { return services_1.RangoClient; } });
+__exportStar(require("./types"), exports);
+//# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,uCAAwC;AAA/B,uGAAA,WAAW,OAAA;AACpB,0CAAuB"}

package/lib/services/client.d.ts

@@ -0,0 +1,19 @@
+import { MetaResponse, QuoteRequest, QuoteResponse, CheckApprovalResponse, StatusRequest, StatusResponse, SwapRequest, SwapResponse, ReportTransactionRequest, WalletDetailsResponse } from "../types";
+declare type WalletAddress = {
+    blockchain: string;
+    address: string;
+};
+export declare class RangoClient {
+    private readonly deviceId;
+    private readonly apiKey;
+    constructor(apiKey: string);
+    meta(): Promise<MetaResponse>;
+    quote(quoteRequest: QuoteRequest): Promise<QuoteResponse>;
+    isApproved(requestId: string, txId: string): Promise<CheckApprovalResponse>;
+    status(statusRequest: StatusRequest): Promise<StatusResponse>;
+    swap(swapRequest: SwapRequest): Promise<SwapResponse>;
+    reportFailure(requestBody: ReportTransactionRequest): Promise<void>;
+    balance(walletAddress: WalletAddress): Promise<WalletDetailsResponse>;
+}
+export {};
+//# sourceMappingURL=client.d.ts.map

package/lib/services/client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../src/services/client.ts"],"names":[],"mappings":"AAGA,OAAO,EACL,YAAY,EACZ,YAAY,EACZ,aAAa,EACb,qBAAqB,EACrB,aAAa,EACb,cAAc,EACd,WAAW,EACX,YAAY,EACZ,wBAAwB,EACxB,qBAAqB,EACtB,MAAM,UAAU,CAAA;AAGjB,aAAK,aAAa,GAAG;IAAE,UAAU,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,MAAM,CAAA;CAAE,CAAA;AAE5D,qBAAa,WAAW;IACtB,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAQ;IAEjC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAQ;gBAEnB,MAAM,EAAE,MAAM;IAoBb,IAAI,IAAI,OAAO,CAAC,YAAY,CAAC;IAO7B,KAAK,CAChB,YAAY,EAAE,YAAY,GACzB,OAAO,CAAC,aAAa,CAAC;IAeZ,UAAU,CACrB,SAAS,EAAE,MAAM,EACjB,IAAI,EAAE,MAAM,GACX,OAAO,CAAC,qBAAqB,CAAC;IAUpB,MAAM,CACjB,aAAa,EAAE,aAAa,GAC3B,OAAO,CAAC,cAAc,CAAC;IAUb,IAAI,CACf,WAAW,EAAE,WAAW,GACvB,OAAO,CAAC,YAAY,CAAC;IAeX,aAAa,CACxB,WAAW,EAAE,wBAAwB,GACpC,OAAO,CAAC,IAAI,CAAC;IAMH,OAAO,CAClB,aAAa,EAAE,aAAa,GAC3B,OAAO,CAAC,qBAAqB,CAAC;CASlC"}

package/lib/services/client.js

@@ -0,0 +1,191 @@
+"use strict";
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+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 (_) 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 };
+    }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RangoClient = void 0;
+var uuid_1 = require("uuid");
+var httpService_1 = require("./httpService");
+var types_1 = require("../types");
+var RangoClient = /** @class */ (function () {
+    function RangoClient(apiKey) {
+        this.apiKey = apiKey;
+        try {
+            if (typeof window !== 'undefined') {
+                var deviceId = localStorage.getItem('deviceId');
+                if (deviceId) {
+                    this.deviceId = deviceId;
+                }
+                else {
+                    var generatedId = (0, uuid_1.v4)();
+                    localStorage.setItem('deviceId', generatedId);
+                    this.deviceId = generatedId;
+                }
+            }
+            else {
+                this.deviceId = (0, uuid_1.v4)();
+            }
+        }
+        catch (e) {
+            this.deviceId = (0, uuid_1.v4)();
+        }
+    }
+    RangoClient.prototype.meta = function () {
+        return __awaiter(this, void 0, void 0, function () {
+            var axiosResponse;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, httpService_1.httpService.get("/basic/meta?apiKey=".concat(this.apiKey))];
+                    case 1:
+                        axiosResponse = _a.sent();
+                        return [2 /*return*/, axiosResponse.data];
+                }
+            });
+        });
+    };
+    RangoClient.prototype.quote = function (quoteRequest) {
+        return __awaiter(this, void 0, void 0, function () {
+            var body, axiosResponse;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        body = __assign(__assign({}, quoteRequest), { from: (0, types_1.assetToString)(quoteRequest.from), to: (0, types_1.assetToString)(quoteRequest.to) });
+                        return [4 /*yield*/, httpService_1.httpService.get("/basic/quote?apiKey=".concat(this.apiKey), {
+                                params: body,
+                                headers: { 'X-Rango-Id': this.deviceId }
+                            })];
+                    case 1:
+                        axiosResponse = _a.sent();
+                        return [2 /*return*/, axiosResponse.data];
+                }
+            });
+        });
+    };
+    RangoClient.prototype.isApproved = function (requestId, txId) {
+        return __awaiter(this, void 0, void 0, function () {
+            var axiosResponse;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, httpService_1.httpService.get("/basic/is-approved?apiKey=".concat(this.apiKey), {
+                            params: { requestId: requestId, txId: txId },
+                            headers: { 'X-Rango-Id': this.deviceId }
+                        })];
+                    case 1:
+                        axiosResponse = _a.sent();
+                        return [2 /*return*/, axiosResponse.data];
+                }
+            });
+        });
+    };
+    RangoClient.prototype.status = function (statusRequest) {
+        return __awaiter(this, void 0, void 0, function () {
+            var axiosResponse;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, httpService_1.httpService.get("/basic/status?apiKey=".concat(this.apiKey), {
+                            params: statusRequest,
+                            headers: { 'X-Rango-Id': this.deviceId }
+                        })];
+                    case 1:
+                        axiosResponse = _a.sent();
+                        return [2 /*return*/, axiosResponse.data];
+                }
+            });
+        });
+    };
+    RangoClient.prototype.swap = function (swapRequest) {
+        return __awaiter(this, void 0, void 0, function () {
+            var body, axiosResponse;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        body = __assign(__assign({}, swapRequest), { from: (0, types_1.assetToString)(swapRequest.from), to: (0, types_1.assetToString)(swapRequest.to) });
+                        return [4 /*yield*/, httpService_1.httpService.get("/basic/swap?apiKey=".concat(this.apiKey), {
+                                params: body,
+                                headers: { 'X-Rango-Id': this.deviceId }
+                            })];
+                    case 1:
+                        axiosResponse = _a.sent();
+                        return [2 /*return*/, axiosResponse.data];
+                }
+            });
+        });
+    };
+    RangoClient.prototype.reportFailure = function (requestBody) {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, httpService_1.httpService.post("/basic/report-tx?apiKey=".concat(this.apiKey), requestBody, {
+                            headers: { 'X-Rango-Id': this.deviceId }
+                        })];
+                    case 1:
+                        _a.sent();
+                        return [2 /*return*/];
+                }
+            });
+        });
+    };
+    RangoClient.prototype.balance = function (walletAddress) {
+        return __awaiter(this, void 0, void 0, function () {
+            var axiosResponse;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, httpService_1.httpService.get("/basic/balance?apiKey=".concat(this.apiKey), {
+                            params: walletAddress,
+                            headers: { 'X-Rango-Id': this.deviceId }
+                        })];
+                    case 1:
+                        axiosResponse = _a.sent();
+                        return [2 /*return*/, axiosResponse.data];
+                }
+            });
+        });
+    };
+    return RangoClient;
+}());
+exports.RangoClient = RangoClient;
+//# sourceMappingURL=client.js.map

package/lib/services/client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.js","sourceRoot":"","sources":["../../src/services/client.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,6BAAyB;AAEzB,6CAA2C;AAC3C,kCAWiB;AAKjB;IAKE,qBAAY,MAAc;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;QACpB,IAAI;YACF,IAAI,OAAO,MAAM,KAAK,WAAW,EAAE;gBACjC,IAAM,QAAQ,GAAG,YAAY,CAAC,OAAO,CAAC,UAAU,CAAC,CAAA;gBACjD,IAAI,QAAQ,EAAE;oBACZ,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAA;iBACzB;qBAAM;oBACL,IAAM,WAAW,GAAG,IAAA,SAAE,GAAE,CAAA;oBACxB,YAAY,CAAC,OAAO,CAAC,UAAU,EAAE,WAAW,CAAC,CAAA;oBAC7C,IAAI,CAAC,QAAQ,GAAG,WAAW,CAAA;iBAC5B;aACF;iBAAM;gBACL,IAAI,CAAC,QAAQ,GAAG,IAAA,SAAE,GAAE,CAAA;aACrB;SACF;QAAC,OAAO,CAAC,EAAE;YACV,IAAI,CAAC,QAAQ,GAAG,IAAA,SAAE,GAAE,CAAA;SACrB;IACH,CAAC;IAEY,0BAAI,GAAjB;;;;;4BACwB,qBAAM,yBAAW,CAAC,GAAG,CACzC,6BAAsB,IAAI,CAAC,MAAM,CAAE,CACpC,EAAA;;wBAFK,aAAa,GAAG,SAErB;wBACD,sBAAO,aAAa,CAAC,IAAI,EAAA;;;;KAC1B;IAEY,2BAAK,GAAlB,UACE,YAA0B;;;;;;wBAEpB,IAAI,yBACL,YAAY,KACf,IAAI,EAAE,IAAA,qBAAa,EAAC,YAAY,CAAC,IAAI,CAAC,EACtC,EAAE,EAAE,IAAA,qBAAa,EAAC,YAAY,CAAC,EAAE,CAAC,GACnC,CAAA;wBACqB,qBAAM,yBAAW,CAAC,GAAG,CACzC,8BAAuB,IAAI,CAAC,MAAM,CAAE,EAAE;gCACpC,MAAM,EAAE,IAAI;gCACZ,OAAO,EAAE,EAAE,YAAY,EAAE,IAAI,CAAC,QAAQ,EAAE;6BACzC,CACF,EAAA;;wBALK,aAAa,GAAG,SAKrB;wBACD,sBAAO,aAAa,CAAC,IAAI,EAAA;;;;KAC1B;IAEY,gCAAU,GAAvB,UACE,SAAiB,EACjB,IAAY;;;;;4BAEU,qBAAM,yBAAW,CAAC,GAAG,CACzC,oCAA6B,IAAI,CAAC,MAAM,CAAE,EAAE;4BAC1C,MAAM,EAAE,EAAE,SAAS,WAAA,EAAE,IAAI,MAAA,EAAE;4BAC3B,OAAO,EAAE,EAAE,YAAY,EAAE,IAAI,CAAC,QAAQ,EAAE;yBACzC,CACF,EAAA;;wBALK,aAAa,GAAG,SAKrB;wBACD,sBAAO,aAAa,CAAC,IAAI,EAAA;;;;KAC1B;IAEY,4BAAM,GAAnB,UACE,aAA4B;;;;;4BAEN,qBAAM,yBAAW,CAAC,GAAG,CACzC,+BAAwB,IAAI,CAAC,MAAM,CAAE,EAAE;4BACrC,MAAM,EAAE,aAAa;4BACrB,OAAO,EAAE,EAAE,YAAY,EAAE,IAAI,CAAC,QAAQ,EAAE;yBACzC,CACF,EAAA;;wBALK,aAAa,GAAG,SAKrB;wBACD,sBAAO,aAAa,CAAC,IAAI,EAAA;;;;KAC1B;IAEY,0BAAI,GAAjB,UACE,WAAwB;;;;;;wBAElB,IAAI,yBACL,WAAW,KACd,IAAI,EAAE,IAAA,qBAAa,EAAC,WAAW,CAAC,IAAI,CAAC,EACrC,EAAE,EAAE,IAAA,qBAAa,EAAC,WAAW,CAAC,EAAE,CAAC,GAClC,CAAA;wBACqB,qBAAM,yBAAW,CAAC,GAAG,CACzC,6BAAsB,IAAI,CAAC,MAAM,CAAE,EAAE;gCACnC,MAAM,EAAE,IAAI;gCACZ,OAAO,EAAE,EAAE,YAAY,EAAE,IAAI,CAAC,QAAQ,EAAE;6BACzC,CACF,EAAA;;wBALK,aAAa,GAAG,SAKrB;wBACD,sBAAO,aAAa,CAAC,IAAI,EAAA;;;;KAC1B;IAEY,mCAAa,GAA1B,UACE,WAAqC;;;;4BAErC,qBAAM,yBAAW,CAAC,IAAI,CAAC,kCAA2B,IAAI,CAAC,MAAM,CAAE,EAAE,WAAW,EAAE;4BAC5E,OAAO,EAAE,EAAE,YAAY,EAAE,IAAI,CAAC,QAAQ,EAAE;yBACzC,CAAC,EAAA;;wBAFF,SAEE,CAAA;;;;;KACH;IAEY,6BAAO,GAApB,UACE,aAA4B;;;;;4BAEN,qBAAM,yBAAW,CAAC,GAAG,CACzC,gCAAyB,IAAI,CAAC,MAAM,CAAE,EAAE;4BACtC,MAAM,EAAE,aAAa;4BACrB,OAAO,EAAE,EAAE,YAAY,EAAE,IAAI,CAAC,QAAQ,EAAE;yBACzC,CACF,EAAA;;wBALK,aAAa,GAAG,SAKrB;wBACD,sBAAO,aAAa,CAAC,IAAI,EAAA;;;;KAC1B;IACH,kBAAC;AAAD,CAAC,AA9GD,IA8GC;AA9GY,kCAAW"}

package/lib/services/httpService.d.ts

@@ -0,0 +1,2 @@
+export declare const httpService: import("axios").AxiosInstance;
+//# sourceMappingURL=httpService.d.ts.map

package/lib/services/httpService.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"httpService.d.ts","sourceRoot":"","sources":["../../src/services/httpService.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,WAAW,+BAEtB,CAAA"}

package/lib/services/httpService.js

@@ -0,0 +1,11 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.httpService = void 0;
+var axios_1 = __importDefault(require("axios"));
+exports.httpService = axios_1.default.create({
+    baseURL: 'https://api.rango.exchange',
+});
+//# sourceMappingURL=httpService.js.map

package/lib/services/httpService.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"httpService.js","sourceRoot":"","sources":["../../src/services/httpService.ts"],"names":[],"mappings":";;;;;;AAAA,gDAAyB;AAEZ,QAAA,WAAW,GAAG,eAAK,CAAC,MAAM,CAAC;IACtC,OAAO,EAAE,4BAA4B;CACtC,CAAC,CAAA"}

package/lib/services/index.d.ts

@@ -0,0 +1,2 @@
+export { RangoClient } from './client';
+//# sourceMappingURL=index.d.ts.map

package/lib/services/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/services/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,UAAU,CAAA"}

package/lib/services/index.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RangoClient = void 0;
+var client_1 = require("./client");
+Object.defineProperty(exports, "RangoClient", { enumerable: true, get: function () { return client_1.RangoClient; } });
+//# sourceMappingURL=index.js.map

package/lib/services/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/services/index.ts"],"names":[],"mappings":";;;AAAA,mCAAsC;AAA7B,qGAAA,WAAW,OAAA"}

package/lib/types/api/balance.d.ts

@@ -0,0 +1,39 @@
+import type { Asset, Amount } from './common';
+/**
+ * Pair of the asset and its amount in wallet balance
+ *
+ * @property {Amount} amount
+ * @property {Asset} asset
+ *
+ */
+export declare type AssetAndAmount = {
+    amount: Amount;
+    asset: Asset;
+};
+/**
+ * Balance of a specific address inside a specific blockchain
+ *
+ * @property {boolean} failed - If true, Rango was not able to fetch balance of this wallet, maybe try again later
+ * @property {string} blockChain - Wallet blockchain
+ * @property {string} address - Wallet address
+ * @property {AssetAndAmount[] | null} balances - Examples: BSC, TERRA, OSMOSIS, ...
+ * @property {string} explorerUrl - The explorer url of the wallet, example: https://bscscan.com/address/0x7a3....fdsza
+ *
+ */
+export declare type WalletDetail = {
+    failed: boolean;
+    blockChain: string;
+    address: string;
+    balances: AssetAndAmount[] | null;
+    explorerUrl: string;
+};
+/**
+ * Response of checking wallet balance
+ *
+ * @property {WalletDetail[]} wallets - list of wallet assets
+ *
+ */
+export declare type WalletDetailsResponse = {
+    wallets: WalletDetail[];
+};
+//# sourceMappingURL=balance.d.ts.map

package/lib/types/api/balance.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"balance.d.ts","sourceRoot":"","sources":["../../../src/types/api/balance.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,UAAU,CAAA;AAE7C;;;;;;GAMG;AACH,oBAAY,cAAc,GAAG;IAC3B,MAAM,EAAE,MAAM,CAAA;IACd,KAAK,EAAE,KAAK,CAAA;CACb,CAAA;AAED;;;;;;;;;GASG;AACH,oBAAY,YAAY,GAAG;IACzB,MAAM,EAAE,OAAO,CAAA;IACf,UAAU,EAAE,MAAM,CAAA;IAClB,OAAO,EAAE,MAAM,CAAA;IACf,QAAQ,EAAE,cAAc,EAAE,GAAG,IAAI,CAAA;IACjC,WAAW,EAAE,MAAM,CAAA;CACpB,CAAA;AAED;;;;;GAKG;AACH,oBAAY,qBAAqB,GAAG;IAClC,OAAO,EAAE,YAAY,EAAE,CAAA;CACxB,CAAA"}

package/lib/types/api/balance.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=balance.js.map

package/lib/types/api/balance.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"balance.js","sourceRoot":"","sources":["../../../src/types/api/balance.ts"],"names":[],"mappings":""}

package/lib/types/api/common.d.ts

@@ -0,0 +1,117 @@
+import { SwapperMetaDto, Token } from "./meta";
+/**
+ * An asset which is unique by (blockchain, symbol, address)
+ *
+ * @property {string} blockchain - The blockchain which this token belongs to
+ * @property {string | null} address - Smart contract address of token, null for native tokens
+ * @property {string} symbol - The display token symbol, e.g. USDT, BTC, ...
+ *
+ */
+export declare type Asset = {
+    blockchain: string;
+    address: string | null;
+    symbol: string;
+};
+export declare function assetToString(asset: Asset): string;
+/**
+ * The amount of an asset, including value & decimals.
+ * The value is machine-readable, to make it human-readable it should be shifted by decimals.
+ *
+ * @property {string} amount - The machine-readable amount shifted by decimals, example: 1000000000000000000
+ * @property {number} decimals - The decimals of the token in blockchain, example: 18
+ *
+ */
+export declare type Amount = {
+    amount: string;
+    decimals: number;
+};
+/**
+ * A fee unit, including the type of asset and the amount of fee
+ *
+ * @property {string} name - A display name for this fee, example: Network Fee
+ * @property {Asset} asset - Underlying asset for paying fee, example: BNB for BSC blockchain
+ * @property {string} amount - The human readable amount of fee, example: 0.004
+ * @property {string} expenseType - Type of the fee, example: FROM_SOURCE_WALLET
+ *
+ */
+export declare type SwapFee = {
+    name: string;
+    expenseType: 'FROM_SOURCE_WALLET' | 'DECREASE_FROM_OUTPUT';
+    asset: Asset;
+    amount: string;
+};
+/**
+ * A quote path from asset x (from) to asset y (to)
+ *
+ * @property {Token} from - The source asset
+ * @property {Token} to - The destination asset
+ * @property {SwapperMetaDto} swapper - Swapper for this path
+ * @property {"BRIDGE" | "DEX" | "COMPOSER"} swapperType - Type of swapper
+ * @property {string} expectedOutput - Expected output
+ *
+ */
+export declare type QuotePath = {
+    from: Token;
+    to: Token;
+    swapper: SwapperMetaDto;
+    swapperType: "BRIDGE" | "DEX" | "COMPOSER";
+    expectedOutput: string;
+};
+/**
+ * Limitations on input amount for requested route
+ *
+ * @property {string | null} min - Limitation on minimum input amount for this route
+ * @property {string | null} max - Limitation on maximum input amount for this route
+ * @property {'INCLUSIVE' | 'EXCLUSIVE'} type - type of limitation
+ *
+ */
+export declare type AmountRestriction = {
+    min: string | null;
+    max: string | null;
+    type: 'INCLUSIVE' | 'EXCLUSIVE';
+};
+/**
+ * A step of a multi-step swap route
+ *
+ * @property {string} outputAmount - The estimation of Rango from output amount of Y
+ *
+ * @property {SwapperMetaDto} swapper - Swapper suggested for this path
+ *
+ * @property {QuotePath[] | null} path - The internal routing of this step showing how the initial swap request will
+ * be split and executed. This can be used for previewing purpose to give the user a sense of what's going to happen.
+ * Null indicates that there is no internal mechanism and swapping is simple and straight-forward.
+ *
+ * @property {SwapFee[]} fee - List of fees that are taken from user in this step
+ *
+ * @property {AmountRestriction | null} amountRestriction - restrictions on input amount. This field is informational
+ * and there is no need to apply it in client-side
+ *
+ * @property {number} estimatedTimeInSeconds - The estimated time (in seconds) that this step might take, beware that
+ * this number is just an estimation and should be used only for user preview, example: 15
+ *
+ */
+export declare type QuoteSimulationResult = {
+    outputAmount: string;
+    swapper: SwapperMetaDto;
+    path: QuotePath[] | null;
+    fee: SwapFee[];
+    amountRestriction: AmountRestriction | null;
+    estimatedTimeInSeconds: number;
+};
+/**
+ * An asset with its ticker
+ *
+ * @property {string} blockchain - Blockchain of asset
+ * @property {string | null} address - Contract address of the asset, null for native tokens
+ * @property {string} symbol - Symbol of an asset, example: BUSD
+ * @property {string} ticker - The ticker of the asset which normally is a combination of symbol and address,
+ * required by some javascript wallets
+ *
+ */
+export declare type AssetWithTicker = {
+    blockchain: string;
+    address: string | null;
+    symbol: string;
+    ticker: string;
+};
+//# sourceMappingURL=common.d.ts.map

package/lib/types/api/common.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"common.d.ts","sourceRoot":"","sources":["../../../src/types/api/common.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,cAAc,EAAE,KAAK,EAAC,MAAM,QAAQ,CAAA;AAE5C;;;;;;;GAOG;AACH,oBAAY,KAAK,GAAG;IAClB,UAAU,EAAE,MAAM,CAAA;IAClB,OAAO,EAAE,MAAM,GAAG,IAAI,CAAA;IACtB,MAAM,EAAE,MAAM,CAAA;CACf,CAAA;AAED,wBAAgB,aAAa,CAAC,KAAK,EAAE,KAAK,GAAG,MAAM,CAKlD;AAED;;;;;;;GAOG;AACH,oBAAY,MAAM,GAAG;IACnB,MAAM,EAAE,MAAM,CAAA;IACd,QAAQ,EAAE,MAAM,CAAA;CACjB,CAAA;AAGD;;;;;;;;GAQG;AACH,oBAAY,OAAO,GAAG;IACpB,IAAI,EAAE,MAAM,CAAA;IACZ,WAAW,EAAE,oBAAoB,GAAG,sBAAsB,CAAA;IAC1D,KAAK,EAAE,KAAK,CAAA;IACZ,MAAM,EAAE,MAAM,CAAA;CACf,CAAA;AAED;;;;;;;;;GASG;AACH,oBAAY,SAAS,GAAG;IACtB,IAAI,EAAE,KAAK,CAAA;IACX,EAAE,EAAE,KAAK,CAAA;IACT,OAAO,EAAE,cAAc,CAAA;IACvB,WAAW,EAAE,QAAQ,GAAG,KAAK,GAAG,UAAU,CAAA;IAC1C,cAAc,EAAE,MAAM,CAAA;CACvB,CAAA;AAED;;;;;;;GAOG;AACH,oBAAY,iBAAiB,GAAG;IAC9B,GAAG,EAAE,MAAM,GAAG,IAAI,CAAA;IAClB,GAAG,EAAE,MAAM,GAAG,IAAI,CAAA;IAClB,IAAI,EAAE,WAAW,GAAG,WAAW,CAAA;CAChC,CAAA;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,oBAAY,qBAAqB,GAAG;IAClC,YAAY,EAAE,MAAM,CAAA;IACpB,OAAO,EAAE,cAAc,CAAA;IACvB,IAAI,EAAE,SAAS,EAAE,GAAG,IAAI,CAAA;IACxB,GAAG,EAAE,OAAO,EAAE,CAAA;IACd,iBAAiB,EAAE,iBAAiB,GAAG,IAAI,CAAA;IAC3C,sBAAsB,EAAE,MAAM,CAAA;CAC/B,CAAA;AAED;;;;;;;;;GASG;AACH,oBAAY,eAAe,GAAG;IAC5B,UAAU,EAAE,MAAM,CAAA;IAClB,OAAO,EAAE,MAAM,GAAG,IAAI,CAAA;IACtB,MAAM,EAAE,MAAM,CAAA;IACd,MAAM,EAAE,MAAM,CAAA;CACf,CAAA"}

package/lib/types/api/common.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.assetToString = void 0;
+function assetToString(asset) {
+    if (!!asset.address)
+        return "".concat(asset.blockchain, ".").concat(asset.symbol, "--").concat(asset.address);
+    else
+        return "".concat(asset.blockchain, ".").concat(asset.symbol);
+}
+exports.assetToString = assetToString;
+//# sourceMappingURL=common.js.map

package/lib/types/api/common.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"common.js","sourceRoot":"","sources":["../../../src/types/api/common.ts"],"names":[],"mappings":";;;AAgBA,SAAgB,aAAa,CAAC,KAAY;IACxC,IAAI,CAAC,CAAC,KAAK,CAAC,OAAO;QACjB,OAAO,UAAG,KAAK,CAAC,UAAU,cAAI,KAAK,CAAC,MAAM,eAAK,KAAK,CAAC,OAAO,CAAE,CAAA;;QAE9D,OAAO,UAAG,KAAK,CAAC,UAAU,cAAI,KAAK,CAAC,MAAM,CAAE,CAAA;AAChD,CAAC;AALD,sCAKC"}

package/lib/types/api/meta.d.ts

@@ -0,0 +1,61 @@
+import type { Asset } from './common';
+import { TransactionType } from "./transactions";
+/**
+ * Blockchain information
+ *
+ * @property {string} name - Unique name of blockchain, this field is used in all endpoints as the identifier
+ * @property {number} defaultDecimals - The default decimals of blockchain, do not use it in computations, use Token.decimals instead
+ * @property {Asset[]} feeAssets - List of assets that can be used as fee in this blockchain
+ * @property {string[]} addressPatterns - List of all regex patterns for wallet addresses of this blockchain, can be
+ * used for input validation, example: [ "^(0x)[0-9A-Fa-f]{40}$" ]
+ * @property {TransactionType | null} type - Type of transactions in this blockchain
+ * @property {string | null} chainId - Chain Id (e.g. 1 for Ethereum)
+ *
+ */
+export declare type BlockchainMeta = {
+    name: string;
+    defaultDecimals: number;
+    feeAssets: Asset[];
+    addressPatterns: string[];
+    type: TransactionType | null;
+    chainId: string | null;
+};
+/**
+ * Metadata of Swapper
+ */
+export declare type SwapperMetaDto = {
+    id: string;
+    title: string;
+    logo: string;
+};
+/**
+ * All metadata info for a token, unique by (blockchain, symbol, address) tuple
+ *
+ * @property {string} blockchain - The blockchain which this token belongs to
+ * @property {string | null} address - Smart contract address of token, null for native tokens
+ * @property {string} symbol - The token symbol, e.g: ADA
+ * @property {number} decimals - Decimals of token in blockchain, example: 18
+ * @property {string} image - Url of its image, example: https://api.rango.exchange/tokens/ETH/ETH.png
+ *
+ */
+export declare type Token = {
+    blockchain: string;
+    address: string | null;
+    symbol: string;
+    decimals: number;
+    image: string;
+};
+/**
+ * Metadata info for all blockchains and tokens supported
+ *
+ * @property {BlockchainMeta[]} blockchains - List of all supported blockchains
+ * @property {Token[]} tokens - List of all tokens
+ * @property {SwapperMetaDto[]} swappers - List of all DEXes & Bridges
+ *
+ */
+export declare type MetaResponse = {
+    blockchains: BlockchainMeta[];
+    tokens: Token[];
+    swappers: SwapperMetaDto[];
+};
+//# sourceMappingURL=meta.d.ts.map

package/lib/types/api/meta.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"meta.d.ts","sourceRoot":"","sources":["../../../src/types/api/meta.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,UAAU,CAAA;AACrC,OAAO,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAC;AAEjD;;;;;;;;;;;GAWG;AACH,oBAAY,cAAc,GAAG;IAC3B,IAAI,EAAE,MAAM,CAAA;IACZ,eAAe,EAAE,MAAM,CAAA;IACvB,SAAS,EAAE,KAAK,EAAE,CAAA;IAClB,eAAe,EAAE,MAAM,EAAE,CAAA;IACzB,IAAI,EAAE,eAAe,GAAG,IAAI,CAAA;IAC5B,OAAO,EAAE,MAAM,GAAG,IAAI,CAAA;CACvB,CAAA;AAED;;GAEG;AACH,oBAAY,cAAc,GAAG;IAC3B,EAAE,EAAE,MAAM,CAAA;IACV,KAAK,EAAE,MAAM,CAAA;IACb,IAAI,EAAE,MAAM,CAAA;CACb,CAAA;AAED;;;;;;;;;GASG;AACH,oBAAY,KAAK,GAAG;IAClB,UAAU,EAAE,MAAM,CAAA;IAClB,OAAO,EAAE,MAAM,GAAG,IAAI,CAAA;IACtB,MAAM,EAAE,MAAM,CAAA;IACd,QAAQ,EAAE,MAAM,CAAA;IAChB,KAAK,EAAE,MAAM,CAAA;CACd,CAAA;AAED;;;;;;;GAOG;AACH,oBAAY,YAAY,GAAG;IACzB,WAAW,EAAE,cAAc,EAAE,CAAA;IAC7B,MAAM,EAAE,KAAK,EAAE,CAAA;IACf,QAAQ,EAAE,cAAc,EAAE,CAAA;CAC3B,CAAA"}

package/lib/types/api/meta.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=meta.js.map

package/lib/types/api/meta.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"meta.js","sourceRoot":"","sources":["../../../src/types/api/meta.ts"],"names":[],"mappings":""}

package/lib/types/api/routing.d.ts

@@ -0,0 +1,31 @@
+import type { Asset, QuoteSimulationResult } from './common';
+/**
+ * Body of quote request
+ *
+ * @property {Asset} from - The source asset
+ * @property {Asset} to - The destination asset
+ * @property {string} amount - The human-readable amount of asset X that is going to be swapped, example: 0.28
+ * @property {string[]} [swappers] - List of all accepted swappers, an empty list means no filter is required
+ *
+ */
+export declare type QuoteRequest = {
+    from: Asset;
+    to: Asset;
+    amount: string;
+    swappers?: string[];
+};
+/**
+ * The response of quote API, if the route field is null, it means that no route is found
+ *
+ * @property {string} requestId - The unique requestId which is generated for this request by the server. It should be
+ * passed down to all other endpoints if this swap continues on. e.g. d10657ce-b13a-405c-825b-b47f8a5016ad
+ * @property {string} resultType - Type of result (OK or error type)
+ * @property {QuoteSimulationResult | null} route - Suggested route
+ *
+ */
+export declare type QuoteResponse = {
+    requestId: string;
+    resultType: "OK" | "HIGH_IMPACT" | "INPUT_LIMIT_ISSUE" | "NO_ROUTE";
+    route: QuoteSimulationResult | null;
+};
+//# sourceMappingURL=routing.d.ts.map

package/lib/types/api/routing.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"routing.d.ts","sourceRoot":"","sources":["../../../src/types/api/routing.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,KAAK,EAAE,qBAAqB,EAAC,MAAM,UAAU,CAAA;AAG1D;;;;;;;;GAQG;AACH,oBAAY,YAAY,GAAG;IACzB,IAAI,EAAE,KAAK,CAAA;IACX,EAAE,EAAE,KAAK,CAAA;IACT,MAAM,EAAE,MAAM,CAAA;IACd,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAA;CACpB,CAAA;AAED;;;;;;;;GAQG;AACH,oBAAY,aAAa,GAAG;IAC1B,SAAS,EAAE,MAAM,CAAA;IACjB,UAAU,EAAE,IAAI,GAAG,aAAa,GAAG,mBAAmB,GAAG,UAAU,CAAA;IACnE,KAAK,EAAE,qBAAqB,GAAG,IAAI,CAAA;CACpC,CAAA"}

package/lib/types/api/routing.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=routing.js.map

package/lib/types/api/routing.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"routing.js","sourceRoot":"","sources":["../../../src/types/api/routing.ts"],"names":[],"mappings":""}