rango-sdk 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.
+
+- [API Documentation](https://rango.exchange/apis/docs)
+- [Examples](https://github.com/rango-exchange/rango-sdk/tree/master/exmaples/)

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,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (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,22 @@
+import type { MetaResponse } from '../types/api/meta';
+import type { BestRouteRequest, BestRouteResponse } from '../types/api/routing';
+import type { CheckApprovalResponse, CheckTxStatusRequest, CreateTransactionRequest, CreateTransactionResponse, ReportTransactionRequest, TransactionStatusResponse } from '../types/api/transactions';
+import type { WalletDetailsResponse } from '../types/api/balance';
+declare type WalletAddresses = {
+    blockchain: string;
+    address: string;
+}[];
+export declare class RangoClient {
+    private readonly deviceId;
+    private readonly apiKey;
+    constructor(apiKey: string);
+    getAllMetadata(): Promise<MetaResponse>;
+    getBestRoute(requestBody: BestRouteRequest): Promise<BestRouteResponse>;
+    checkApproval(requestId: string): Promise<CheckApprovalResponse>;
+    checkStatus(requestBody: CheckTxStatusRequest): Promise<TransactionStatusResponse>;
+    createTransaction(requestBody: CreateTransactionRequest): Promise<CreateTransactionResponse>;
+    reportFailure(requestBody: ReportTransactionRequest): Promise<void>;
+    getWalletsDetails(walletAddresses: WalletAddresses): 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,KAAK,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAA;AACrD,OAAO,KAAK,EAAE,gBAAgB,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAA;AAC/E,OAAO,KAAK,EACV,qBAAqB,EACrB,oBAAoB,EACpB,wBAAwB,EACxB,yBAAyB,EACzB,wBAAwB,EACxB,yBAAyB,EAC1B,MAAM,2BAA2B,CAAA;AAClC,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,sBAAsB,CAAA;AAEjE,aAAK,eAAe,GAAG;IAAE,UAAU,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,MAAM,CAAA;CAAE,EAAE,CAAA;AAEhE,qBAAa,WAAW;IACtB,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAQ;IAEjC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAQ;gBAEnB,MAAM,EAAE,MAAM;IAgBb,cAAc,IAAI,OAAO,CAAC,YAAY,CAAC;IAOvC,YAAY,CACvB,WAAW,EAAE,gBAAgB,GAC5B,OAAO,CAAC,iBAAiB,CAAC;IAShB,aAAa,CACxB,SAAS,EAAE,MAAM,GAChB,OAAO,CAAC,qBAAqB,CAAC;IAOpB,WAAW,CACtB,WAAW,EAAE,oBAAoB,GAChC,OAAO,CAAC,yBAAyB,CAAC;IAQxB,iBAAiB,CAC5B,WAAW,EAAE,wBAAwB,GACpC,OAAO,CAAC,yBAAyB,CAAC;IAQxB,aAAa,CACxB,WAAW,EAAE,wBAAwB,GACpC,OAAO,CAAC,IAAI,CAAC;IAIH,iBAAiB,CAC5B,eAAe,EAAE,eAAe,GAC/B,OAAO,CAAC,qBAAqB,CAAC;CAWlC"}

package/lib/services/client.js

@@ -0,0 +1,159 @@
+"use strict";
+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 RangoClient = /** @class */ (function () {
+    function RangoClient(apiKey) {
+        this.apiKey = apiKey;
+        if (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)();
+        }
+    }
+    RangoClient.prototype.getAllMetadata = 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("/meta?apiKey=".concat(this.apiKey))];
+                    case 1:
+                        axiosResponse = _a.sent();
+                        return [2 /*return*/, axiosResponse.data];
+                }
+            });
+        });
+    };
+    RangoClient.prototype.getBestRoute = function (requestBody) {
+        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.post("/routing/best?apiKey=".concat(this.apiKey), requestBody, { headers: { 'X-Rango-Id': this.deviceId } })];
+                    case 1:
+                        axiosResponse = _a.sent();
+                        return [2 /*return*/, axiosResponse.data];
+                }
+            });
+        });
+    };
+    RangoClient.prototype.checkApproval = function (requestId) {
+        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("/tx/".concat(requestId, "/check-approval?apiKey=").concat(this.apiKey))];
+                    case 1:
+                        axiosResponse = _a.sent();
+                        return [2 /*return*/, axiosResponse.data];
+                }
+            });
+        });
+    };
+    RangoClient.prototype.checkStatus = function (requestBody) {
+        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.post("/tx/check-status?apiKey=".concat(this.apiKey), requestBody)];
+                    case 1:
+                        axiosResponse = _a.sent();
+                        return [2 /*return*/, axiosResponse.data];
+                }
+            });
+        });
+    };
+    RangoClient.prototype.createTransaction = function (requestBody) {
+        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.post("/tx/create?apiKey=".concat(this.apiKey), requestBody)];
+                    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("/tx/report-tx?apiKey=".concat(this.apiKey), requestBody)];
+                    case 1:
+                        _a.sent();
+                        return [2 /*return*/];
+                }
+            });
+        });
+    };
+    RangoClient.prototype.getWalletsDetails = function (walletAddresses) {
+        return __awaiter(this, void 0, void 0, function () {
+            var walletAddressesQueryParams, i, walletAddress, axiosResponse;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        walletAddressesQueryParams = '';
+                        for (i = 0; i < walletAddresses.length; i++) {
+                            walletAddress = walletAddresses[i];
+                            walletAddressesQueryParams += "&address=".concat(walletAddress.blockchain, ".").concat(walletAddress.address);
+                        }
+                        return [4 /*yield*/, httpService_1.httpService.get("/wallets/details?apiKey=".concat(this.apiKey).concat(walletAddressesQueryParams))];
+                    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;AAe3C;IAKE,qBAAY,MAAc;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;QACpB,IAAI,MAAM,IAAI,SAAS,EAAE;YACvB,IAAM,QAAQ,GAAG,YAAY,CAAC,OAAO,CAAC,UAAU,CAAC,CAAA;YACjD,IAAI,QAAQ,EAAE;gBACZ,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAA;aACzB;iBAAM;gBACL,IAAM,WAAW,GAAG,IAAA,SAAE,GAAE,CAAA;gBACxB,YAAY,CAAC,OAAO,CAAC,UAAU,EAAE,WAAW,CAAC,CAAA;gBAC7C,IAAI,CAAC,QAAQ,GAAG,WAAW,CAAA;aAC5B;SACF;aAAM;YACL,IAAI,CAAC,QAAQ,GAAG,IAAA,SAAE,GAAE,CAAA;SACrB;IACH,CAAC;IAEY,oCAAc,GAA3B;;;;;4BACwB,qBAAM,yBAAW,CAAC,GAAG,CACzC,uBAAgB,IAAI,CAAC,MAAM,CAAE,CAC9B,EAAA;;wBAFK,aAAa,GAAG,SAErB;wBACD,sBAAO,aAAa,CAAC,IAAI,EAAA;;;;KAC1B;IAEY,kCAAY,GAAzB,UACE,WAA6B;;;;;4BAEP,qBAAM,yBAAW,CAAC,IAAI,CAC1C,+BAAwB,IAAI,CAAC,MAAM,CAAE,EACrC,WAAW,EACX,EAAE,OAAO,EAAE,EAAE,YAAY,EAAE,IAAI,CAAC,QAAQ,EAAE,EAAE,CAC7C,EAAA;;wBAJK,aAAa,GAAG,SAIrB;wBACD,sBAAO,aAAa,CAAC,IAAI,EAAA;;;;KAC1B;IAEY,mCAAa,GAA1B,UACE,SAAiB;;;;;4BAEK,qBAAM,yBAAW,CAAC,GAAG,CACzC,cAAO,SAAS,oCAA0B,IAAI,CAAC,MAAM,CAAE,CACxD,EAAA;;wBAFK,aAAa,GAAG,SAErB;wBACD,sBAAO,aAAa,CAAC,IAAI,EAAA;;;;KAC1B;IAEY,iCAAW,GAAxB,UACE,WAAiC;;;;;4BAEX,qBAAM,yBAAW,CAAC,IAAI,CAC1C,kCAA2B,IAAI,CAAC,MAAM,CAAE,EACxC,WAAW,CACZ,EAAA;;wBAHK,aAAa,GAAG,SAGrB;wBACD,sBAAO,aAAa,CAAC,IAAI,EAAA;;;;KAC1B;IAEY,uCAAiB,GAA9B,UACE,WAAqC;;;;;4BAEf,qBAAM,yBAAW,CAAC,IAAI,CAC1C,4BAAqB,IAAI,CAAC,MAAM,CAAE,EAClC,WAAW,CACZ,EAAA;;wBAHK,aAAa,GAAG,SAGrB;wBACD,sBAAO,aAAa,CAAC,IAAI,EAAA;;;;KAC1B;IAEY,mCAAa,GAA1B,UACE,WAAqC;;;;4BAErC,qBAAM,yBAAW,CAAC,IAAI,CAAC,+BAAwB,IAAI,CAAC,MAAM,CAAE,EAAE,WAAW,CAAC,EAAA;;wBAA1E,SAA0E,CAAA;;;;;KAC3E;IAEY,uCAAiB,GAA9B,UACE,eAAgC;;;;;;wBAE5B,0BAA0B,GAAG,EAAE,CAAA;wBACnC,KAAS,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,eAAe,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;4BACzC,aAAa,GAAG,eAAe,CAAC,CAAC,CAAC,CAAA;4BACxC,0BAA0B,IAAI,mBAAY,aAAa,CAAC,UAAU,cAAI,aAAa,CAAC,OAAO,CAAE,CAAA;yBAC9F;wBACqB,qBAAM,yBAAW,CAAC,GAAG,CACzC,kCAA2B,IAAI,CAAC,MAAM,SAAG,0BAA0B,CAAE,CACtE,EAAA;;wBAFK,aAAa,GAAG,SAErB;wBACD,sBAAO,aAAa,CAAC,IAAI,EAAA;;;;KAC1B;IACH,kBAAC;AAAD,CAAC,AAvFD,IAuFC;AAvFY,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,212 @@
+/**
+ * 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;
+};
+/**
+ * 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;
+};
+/**
+ * Minimum required slippage of a step
+ *
+ * @property {boolean} error - If true, means that Rango failed to compute slippage for this step.
+ * @property {number} slippage - The slippage amount in percent, example: 5
+ *
+ */
+export declare type RecommendedSlippage = {
+    error: boolean;
+    slippage: 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;
+};
+/**
+ * Source or destination asset of a route step
+ *
+ * @property {string} blockchain - Blockchain of the source/destination asset of this step
+ * @property {string} symbol - Symbol of the source/destination asset of this step, example: OSMO
+ * @property {string | number} address - Contract address of the source/dest asset of this step, null for native token
+ * @property {number} decimals - Decimals of the source/destination asset of this step, example: 18
+ * @property {string} logo - Absolute path of the logo of the source/destination asset of this step
+ *
+ */
+export declare type SwapResultAsset = {
+    blockchain: string;
+    address: string | null;
+    symbol: string;
+    logo: string;
+    decimals: number;
+};
+/**
+ * A node of the swap path
+ *
+ * @property {string | null} marketId - Id of the market
+ * @property {string | null} marketName - Name of the market, example: Uniswap
+ * @property {number} percent - Percent of the allocation to this path, example: 45
+ *
+ */
+export declare type SwapNode = {
+    marketId: string | null;
+    marketName: string;
+    percent: number;
+};
+/**
+ * A swap path from asset x (from) to asset y (to)
+ *
+ * @property {string} from - Symbol of the source asset
+ * @property {string | null} fromAddress - Contract address of source asset, null for native tokens
+ * @property {string} fromBlockchain - Blockchain of the source asset
+ * @property {string} fromLogo - Absolute path of logo of the source asset
+ *
+ * @property {string} to - Symbol of the destination asset
+ * @property {string | null} toAddress - Contract address of destination asset, null for native tokens
+ * @property {string} toBlockchain - Blockchain of the destination asset
+ * @property {string} toLogo - Absolute path of logo of the destination asset
+ *
+ * @property {SwapNode[]} nodes - List of intermediate nodes in a swap path
+ *
+ */
+export declare type SwapSuperNode = {
+    from: string;
+    fromAddress: string | null;
+    fromBlockchain: string;
+    fromLogo: string;
+    to: string;
+    toAddress: string | null;
+    toBlockchain: string;
+    toLogo: string;
+    nodes: SwapNode[];
+};
+/**
+ * Internal mechanism of a step
+ *
+ * @property {SwapSuperNode[] | null} nodes - List of parallel paths that splitting happens
+ *
+ */
+export declare type SwapRoute = {
+    nodes: SwapSuperNode[] | null;
+};
+/**
+ * Time estimation details for a step of swap route
+ *
+ * @property {number} min - The minimum duration (in seconds) that usually takes for related step
+ * @property {number} avg - The average duration (in seconds) that usually takes for related step
+ * @property {number} max - The maximum duration (in seconds) that usually takes for related step
+ *
+ */
+export declare type TimeStat = {
+    min: number;
+    avg: number;
+    max: number;
+};
+/**
+ * A step of a multi-step swap route
+ *
+ * @property {string} swapperId - Unique Id of swapper. example: 1INCH_BSC, TERRASWAP
+ *
+ * @property {string} swapperType - Type of swapper. example: BRIDGE, DEX
+ *
+ * @property {SwapResultAsset} from - The source asset
+ *
+ * @property {SwapResultAsset} to - The destination asset
+ *
+ * @property {string} fromAmount - Estimated input amount of this step. Can be used for previewing to user and should
+ * not be used for real computation, since it may change when the real transaction happens due to volatility of the market
+ *
+ * @property {string} toAmount - Estimated output amount of this step. Can be used for previewing to user and should
+ * not be used for real computation, since it may change when the real transaction happens due to volatility of the market
+ *
+ * @property {SwapRoute[] | null} routes - 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 {number | null} fromAmountMinValue - The minimum amount unit, the precision that will be applied to
+ * transaction amount in create transaction endpoint automatically by Rango. This field is informational and there is
+ * no need to apply it in client-side.
+ *
+ * @property {number | null} fromAmountMaxValue - Exactly the same as fromAmountMinValue, but for the maximum limit
+ *
+ * @property {number | null} fromAmountPrecision - The minimum amount unit, the precision that will be applied to
+ * transaction amount in create transaction endpoint automatically by Rango. This field is informational and there
+ * is no need to apply it in client-side
+ *
+ * @property {string} fromAmountRestrictionType - Specifies range for fromAmount (Min / Max) Value. for example if value
+ * is EXCLUSIVE and fromAmountMinValue is 20, user can execute transaction if inputValue > 20, but for INCLUSIVE
+ * inputValue >= 20 is valid. possible values: INCLUSIVE / EXCLUSIVE
+ *
+ * @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
+ *
+ * @property {TimeStat | null} timeStat - The minimum, avg and max estimation time for this step
+ *
+ * @property {RecommendedSlippage | null} recommendedSlippage
+ *
+ * @property {string[] | null} warnings - List of warnings for this swap step, usually null or empty
+ *
+ */
+export declare type SwapResult = {
+    swapperId: string;
+    swapperType: string;
+    from: SwapResultAsset;
+    to: SwapResultAsset;
+    fromAmount: string;
+    toAmount: string;
+    routes: SwapRoute[] | null;
+    fee: SwapFee[];
+    fromAmountMaxValue: number | null;
+    fromAmountMinValue: number | null;
+    fromAmountPrecision: number | null;
+    fromAmountRestrictionType: 'EXCLUSIVE' | 'INCLUSIVE';
+    estimatedTimeInSeconds: number;
+    timeStat: TimeStat | null;
+    recommendedSlippage: RecommendedSlippage | null;
+    warnings: string[] | null;
+};
+/**
+ * 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;;;;;;;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;;;;;;;GAOG;AACH,oBAAY,MAAM,GAAG;IACnB,MAAM,EAAE,MAAM,CAAA;IACd,QAAQ,EAAE,MAAM,CAAA;CACjB,CAAA;AAED;;;;;;GAMG;AACH,oBAAY,mBAAmB,GAAG;IAChC,KAAK,EAAE,OAAO,CAAA;IACd,QAAQ,EAAE,MAAM,CAAA;CACjB,CAAA;AAED;;;;;;;;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,eAAe,GAAG;IAC5B,UAAU,EAAE,MAAM,CAAA;IAClB,OAAO,EAAE,MAAM,GAAG,IAAI,CAAA;IACtB,MAAM,EAAE,MAAM,CAAA;IACd,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,EAAE,MAAM,CAAA;CACjB,CAAA;AAED;;;;;;;GAOG;AACH,oBAAY,QAAQ,GAAG;IACrB,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAA;IACvB,UAAU,EAAE,MAAM,CAAA;IAClB,OAAO,EAAE,MAAM,CAAA;CAChB,CAAA;AAED;;;;;;;;;;;;;;;GAeG;AACH,oBAAY,aAAa,GAAG;IAC1B,IAAI,EAAE,MAAM,CAAA;IACZ,WAAW,EAAE,MAAM,GAAG,IAAI,CAAA;IAC1B,cAAc,EAAE,MAAM,CAAA;IACtB,QAAQ,EAAE,MAAM,CAAA;IAChB,EAAE,EAAE,MAAM,CAAA;IACV,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;IACxB,YAAY,EAAE,MAAM,CAAA;IACpB,MAAM,EAAE,MAAM,CAAA;IACd,KAAK,EAAE,QAAQ,EAAE,CAAA;CAClB,CAAA;AAED;;;;;GAKG;AACH,oBAAY,SAAS,GAAG;IACtB,KAAK,EAAE,aAAa,EAAE,GAAG,IAAI,CAAA;CAC9B,CAAA;AAED;;;;;;;GAOG;AACH,oBAAY,QAAQ,GAAG;IACrB,GAAG,EAAE,MAAM,CAAA;IACX,GAAG,EAAE,MAAM,CAAA;IACX,GAAG,EAAE,MAAM,CAAA;CACZ,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8CG;AACH,oBAAY,UAAU,GAAG;IACvB,SAAS,EAAE,MAAM,CAAA;IACjB,WAAW,EAAE,MAAM,CAAA;IACnB,IAAI,EAAE,eAAe,CAAA;IACrB,EAAE,EAAE,eAAe,CAAA;IACnB,UAAU,EAAE,MAAM,CAAA;IAClB,QAAQ,EAAE,MAAM,CAAA;IAChB,MAAM,EAAE,SAAS,EAAE,GAAG,IAAI,CAAA;IAC1B,GAAG,EAAE,OAAO,EAAE,CAAA;IACd,kBAAkB,EAAE,MAAM,GAAG,IAAI,CAAA;IACjC,kBAAkB,EAAE,MAAM,GAAG,IAAI,CAAA;IACjC,mBAAmB,EAAE,MAAM,GAAG,IAAI,CAAA;IAClC,yBAAyB,EAAE,WAAW,GAAG,WAAW,CAAA;IACpD,sBAAsB,EAAE,MAAM,CAAA;IAC9B,QAAQ,EAAE,QAAQ,GAAG,IAAI,CAAA;IACzB,mBAAmB,EAAE,mBAAmB,GAAG,IAAI,CAAA;IAC/C,QAAQ,EAAE,MAAM,EAAE,GAAG,IAAI,CAAA;CAC1B,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,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# 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":""}

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

@@ -0,0 +1,69 @@
+import type { Asset } from './common';
+/**
+ * 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}$" ]
+ *
+ */
+export declare type BlockchainMeta = {
+    name: string;
+    defaultDecimals: number;
+    feeAssets: Asset[];
+    addressPatterns: string[];
+};
+/**
+ * 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 {string | null} name - Display name of token, e.g: Cardano for ADA. It can be null
+ * @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
+ * @property {number | null} usdPrice - USD unit price of this token if available
+ * @property {boolean} isSecondaryCoin - If true, means that the token's trading is high risk. Better to warn user before proceeding
+ * @property {string | null} coinSource - If the token is secondary, coinSource indicates the third-party list
+ * that Rango found this token in, example: Pancake Extended List
+ * @property {string | null} coinSourceUrl - The absolute url of the source list that token was extracted from
+ *
+ */
+export declare type Token = {
+    blockchain: string;
+    address: string | null;
+    symbol: string;
+    name: string | null;
+    decimals: number;
+    image: string;
+    usdPrice: number | null;
+    isSecondaryCoin: boolean;
+    coinSource: string | null;
+    coinSourceUrl: string | null;
+};
+/**
+ * Metadata info for all blockchains and tokens supported
+ *
+ * @property {BlockchainMeta[]} blockChains - List of all supported blockchains
+ * @property {Token[]} tokens - List of all tokens
+ * @property {Token[]} popularTokens - List of popular tokens, a subset of tokens field
+ * @property {SwapperMetaDto[]} swappers - List of all DEXes & Bridges
+ *
+ */
+export declare type MetaResponse = {
+    blockChains: BlockchainMeta[];
+    tokens: Token[];
+    popularTokens: 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;AAErC;;;;;;;;;GASG;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;CAC1B,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;;;;;;;;;;;;;;;GAeG;AACH,oBAAY,KAAK,GAAG;IAClB,UAAU,EAAE,MAAM,CAAA;IAClB,OAAO,EAAE,MAAM,GAAG,IAAI,CAAA;IACtB,MAAM,EAAE,MAAM,CAAA;IACd,IAAI,EAAE,MAAM,GAAG,IAAI,CAAA;IACnB,QAAQ,EAAE,MAAM,CAAA;IAChB,KAAK,EAAE,MAAM,CAAA;IACb,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAA;IACvB,eAAe,EAAE,OAAO,CAAA;IACxB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB,aAAa,EAAE,MAAM,GAAG,IAAI,CAAA;CAC7B,CAAA;AAED;;;;;;;;GAQG;AACH,oBAAY,YAAY,GAAG;IACzB,WAAW,EAAE,cAAc,EAAE,CAAA;IAC7B,MAAM,EAAE,KAAK,EAAE,CAAA;IACf,aAAa,EAAE,KAAK,EAAE,CAAA;IACtB,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":""}