@mento-protocol/mento-sdk 1.0.3 → 1.0.5

package/dist/constants/index.js

@@ -0,0 +1,24 @@
+"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 });
+__exportStar(require("./addresses"), exports);
+__exportStar(require("./chainId"), exports);
+__exportStar(require("./proposalState"), exports);
+__exportStar(require("./contractNames"), exports);
+__exportStar(require("./stableTokenMetadata"), exports);
+__exportStar(require("./protocolAddresses"), exports);
+__exportStar(require("./mentoAddresses"), exports);
+//# sourceMappingURL=index.js.map

package/dist/constants/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/constants/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,8CAA2B;AAC3B,4CAAyB;AACzB,kDAA+B;AAC/B,kDAA+B;AAC/B,wDAAqC;AACrC,sDAAmC;AACnC,mDAAgC"}

package/dist/constants/mentoAddresses.d.ts

@@ -0,0 +1,4 @@
+export declare const MENTO_ADDRESSES: {
+    readonly PROTOCOL_MULTISIG: "0x87647780180b8f55980c7d3ffefe08a9b29e9ae1";
+};
+//# sourceMappingURL=mentoAddresses.d.ts.map

package/dist/constants/mentoAddresses.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mentoAddresses.d.ts","sourceRoot":"","sources":["../../src/constants/mentoAddresses.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,eAAe;;CAElB,CAAA"}

package/dist/constants/mentoAddresses.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MENTO_ADDRESSES = void 0;
+exports.MENTO_ADDRESSES = {
+    PROTOCOL_MULTISIG: '0x87647780180b8f55980c7d3ffefe08a9b29e9ae1',
+};
+//# sourceMappingURL=mentoAddresses.js.map

package/dist/constants/mentoAddresses.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mentoAddresses.js","sourceRoot":"","sources":["../../src/constants/mentoAddresses.ts"],"names":[],"mappings":";;;AAAa,QAAA,eAAe,GAAG;IAC7B,iBAAiB,EAAE,4CAA4C;CACvD,CAAA"}

package/dist/constants/proposalState.d.ts

@@ -0,0 +1,11 @@
+export declare enum ProposalState {
+    PENDING = 0,
+    ACTIVE = 1,
+    CANCELED = 2,
+    DEFEATED = 3,
+    SUCCEEDED = 4,
+    QUEUED = 5,
+    EXPIRED = 6,
+    EXECUTED = 7
+}
+//# sourceMappingURL=proposalState.d.ts.map

package/dist/constants/proposalState.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"proposalState.d.ts","sourceRoot":"","sources":["../../src/constants/proposalState.ts"],"names":[],"mappings":"AAAA,oBAAY,aAAa;IACvB,OAAO,IAAI;IACX,MAAM,IAAI;IACV,QAAQ,IAAI;IACZ,QAAQ,IAAI;IACZ,SAAS,IAAI;IACb,MAAM,IAAI;IACV,OAAO,IAAI;IACX,QAAQ,IAAI;CACb"}

package/dist/constants/proposalState.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ProposalState = void 0;
+var ProposalState;
+(function (ProposalState) {
+    ProposalState[ProposalState["PENDING"] = 0] = "PENDING";
+    ProposalState[ProposalState["ACTIVE"] = 1] = "ACTIVE";
+    ProposalState[ProposalState["CANCELED"] = 2] = "CANCELED";
+    ProposalState[ProposalState["DEFEATED"] = 3] = "DEFEATED";
+    ProposalState[ProposalState["SUCCEEDED"] = 4] = "SUCCEEDED";
+    ProposalState[ProposalState["QUEUED"] = 5] = "QUEUED";
+    ProposalState[ProposalState["EXPIRED"] = 6] = "EXPIRED";
+    ProposalState[ProposalState["EXECUTED"] = 7] = "EXECUTED";
+})(ProposalState || (exports.ProposalState = ProposalState = {}));
+//# sourceMappingURL=proposalState.js.map

package/dist/constants/proposalState.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"proposalState.js","sourceRoot":"","sources":["../../src/constants/proposalState.ts"],"names":[],"mappings":";;;AAAA,IAAY,aASX;AATD,WAAY,aAAa;IACvB,uDAAW,CAAA;IACX,qDAAU,CAAA;IACV,yDAAY,CAAA;IACZ,yDAAY,CAAA;IACZ,2DAAa,CAAA;IACb,qDAAU,CAAA;IACV,uDAAW,CAAA;IACX,yDAAY,CAAA;AACd,CAAC,EATW,aAAa,6BAAb,aAAa,QASxB"}

package/dist/constants/protocolAddresses.d.ts

@@ -0,0 +1,5 @@
+export declare const PROTOCOL_ADDRESSES: {
+    readonly UNIV3_POSITION_MANAGER: "0x3d79EdAaBC0EaB6F08ED885C05Fc0B014290D95A";
+    readonly UNIV3_FACTORY: "0xAfE208a311B21f13EF87E33A90049fC17A7acDEc";
+};
+//# sourceMappingURL=protocolAddresses.d.ts.map

package/dist/constants/protocolAddresses.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"protocolAddresses.d.ts","sourceRoot":"","sources":["../../src/constants/protocolAddresses.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,kBAAkB;;;CAGrB,CAAA"}

package/dist/constants/protocolAddresses.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PROTOCOL_ADDRESSES = void 0;
+exports.PROTOCOL_ADDRESSES = {
+    UNIV3_POSITION_MANAGER: '0x3d79EdAaBC0EaB6F08ED885C05Fc0B014290D95A',
+    UNIV3_FACTORY: '0xAfE208a311B21f13EF87E33A90049fC17A7acDEc',
+};
+//# sourceMappingURL=protocolAddresses.js.map

package/dist/constants/protocolAddresses.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"protocolAddresses.js","sourceRoot":"","sources":["../../src/constants/protocolAddresses.ts"],"names":[],"mappings":";;;AAAa,QAAA,kBAAkB,GAAG;IAChC,sBAAsB,EAAE,4CAA4C;IACpE,aAAa,EAAE,4CAA4C;CACnD,CAAA"}

package/dist/constants/stableTokenMetadata.d.ts

@@ -0,0 +1,14 @@
+export declare const STABLE_TOKEN_SYMBOLS: {
+    readonly cUSD: "cUSD";
+    readonly cEUR: "cEUR";
+    readonly cREAL: "cREAL";
+    readonly cKES: "cKES";
+    readonly PUSO: "PUSO";
+    readonly cCOP: "cCOP";
+    readonly eXOF: "eXOF";
+    readonly cGHS: "cGHS";
+};
+export type StableTokenSymbol = keyof typeof STABLE_TOKEN_SYMBOLS;
+export declare const STABLE_TOKEN_FIAT_MAPPING: Record<StableTokenSymbol, string>;
+export declare function getFiatTicker(symbol: StableTokenSymbol): string;
+//# sourceMappingURL=stableTokenMetadata.d.ts.map

package/dist/constants/stableTokenMetadata.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"stableTokenMetadata.d.ts","sourceRoot":"","sources":["../../src/constants/stableTokenMetadata.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,oBAAoB;;;;;;;;;CASvB,CAAA;AAEV,MAAM,MAAM,iBAAiB,GAAG,MAAM,OAAO,oBAAoB,CAAA;AAEjE,eAAO,MAAM,yBAAyB,EAAE,MAAM,CAAC,iBAAiB,EAAE,MAAM,CAS9D,CAAA;AAEV,wBAAgB,aAAa,CAAC,MAAM,EAAE,iBAAiB,GAAG,MAAM,CAM/D"}

package/dist/constants/stableTokenMetadata.js

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.STABLE_TOKEN_FIAT_MAPPING = exports.STABLE_TOKEN_SYMBOLS = void 0;
+exports.getFiatTicker = getFiatTicker;
+exports.STABLE_TOKEN_SYMBOLS = {
+    cUSD: 'cUSD',
+    cEUR: 'cEUR',
+    cREAL: 'cREAL',
+    cKES: 'cKES',
+    PUSO: 'PUSO',
+    cCOP: 'cCOP',
+    eXOF: 'eXOF',
+    cGHS: 'cGHS',
+};
+exports.STABLE_TOKEN_FIAT_MAPPING = {
+    cUSD: 'USD',
+    cEUR: 'EUR',
+    cREAL: 'BRL',
+    cKES: 'KES',
+    PUSO: 'PHP',
+    cCOP: 'COP',
+    eXOF: 'XOF',
+    cGHS: 'GHS',
+};
+function getFiatTicker(symbol) {
+    const ticker = exports.STABLE_TOKEN_FIAT_MAPPING[symbol];
+    if (!ticker) {
+        throw new Error(`No fiat ticker found for token symbol: ${symbol}`);
+    }
+    return ticker;
+}
+//# sourceMappingURL=stableTokenMetadata.js.map

package/dist/constants/stableTokenMetadata.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"stableTokenMetadata.js","sourceRoot":"","sources":["../../src/constants/stableTokenMetadata.ts"],"names":[],"mappings":";;;AAwBA,sCAMC;AA9BY,QAAA,oBAAoB,GAAG;IAClC,IAAI,EAAE,MAAM;IACZ,IAAI,EAAE,MAAM;IACZ,KAAK,EAAE,OAAO;IACd,IAAI,EAAE,MAAM;IACZ,IAAI,EAAE,MAAM;IACZ,IAAI,EAAE,MAAM;IACZ,IAAI,EAAE,MAAM;IACZ,IAAI,EAAE,MAAM;CACJ,CAAA;AAIG,QAAA,yBAAyB,GAAsC;IAC1E,IAAI,EAAE,KAAK;IACX,IAAI,EAAE,KAAK;IACX,KAAK,EAAE,KAAK;IACZ,IAAI,EAAE,KAAK;IACX,IAAI,EAAE,KAAK;IACX,IAAI,EAAE,KAAK;IACX,IAAI,EAAE,KAAK;IACX,IAAI,EAAE,KAAK;CACH,CAAA;AAEV,SAAgB,aAAa,CAAC,MAAyB;IACrD,MAAM,MAAM,GAAG,iCAAyB,CAAC,MAAM,CAAC,CAAA;IAChD,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,MAAM,IAAI,KAAK,CAAC,0CAA0C,MAAM,EAAE,CAAC,CAAA;IACrE,CAAC;IACD,OAAO,MAAM,CAAA;AACf,CAAC"}

package/dist/esm/constants/addresses.js

@@ -72,7 +72,7 @@ export const addresses = {
 };
 export function getAddress(identifier, chainId) {
     const addressesForChain = addresses[chainId];
-    if (!addressesForChain) {
+    if (!addresses) {
         throw new Error(`No addresses found for chain ID ${chainId}`);
     }
     const address = addressesForChain[identifier];

package/dist/esm/constants/tradablePairs.js

@@ -368,29 +368,6 @@ export const TRADABLE_PAIRS = {
                 },
             ],
         },
-        {
-            id: 'cGHS-cUSD',
-            assets: [
-                {
-                    address: '0xfAeA5F3404bbA20D3cc2f8C4B0A888F55a3c7313',
-                    symbol: 'cGHS',
-                },
-                {
-                    address: '0x765DE816845861e75A25fCA122bb6898B8B1282a',
-                    symbol: 'cUSD',
-                },
-            ],
-            path: [
-                {
-                    providerAddr: '0x22d9db95E6Ae61c104A7B6F6C78D7993B94ec901',
-                    id: '0x3562f9d29eba092b857480a82b03375839c752346b9ebe93a57ab82410328187',
-                    assets: [
-                        '0x765DE816845861e75A25fCA122bb6898B8B1282a',
-                        '0xfAeA5F3404bbA20D3cc2f8C4B0A888F55a3c7313',
-                    ],
-                },
-            ],
-        },
         {
             id: 'CELO-cKES',
             assets: [
@@ -577,37 +554,6 @@ export const TRADABLE_PAIRS = {
                 },
             ],
         },
-        {
-            id: 'CELO-cGHS',
-            assets: [
-                {
-                    address: '0x471EcE3750Da237f93B8E339c536989b8978a438',
-                    symbol: 'CELO',
-                },
-                {
-                    address: '0xfAeA5F3404bbA20D3cc2f8C4B0A888F55a3c7313',
-                    symbol: 'cGHS',
-                },
-            ],
-            path: [
-                {
-                    providerAddr: '0x22d9db95E6Ae61c104A7B6F6C78D7993B94ec901',
-                    id: '0x3135b662c38265d0655177091f1b647b4fef511103d06c016efdf18b46930d2c',
-                    assets: [
-                        '0x765DE816845861e75A25fCA122bb6898B8B1282a',
-                        '0x471EcE3750Da237f93B8E339c536989b8978a438',
-                    ],
-                },
-                {
-                    providerAddr: '0x22d9db95E6Ae61c104A7B6F6C78D7993B94ec901',
-                    id: '0x3562f9d29eba092b857480a82b03375839c752346b9ebe93a57ab82410328187',
-                    assets: [
-                        '0x765DE816845861e75A25fCA122bb6898B8B1282a',
-                        '0xfAeA5F3404bbA20D3cc2f8C4B0A888F55a3c7313',
-                    ],
-                },
-            ],
-        },
         {
             id: 'CELO-axlEUROC',
             assets: [
@@ -1011,37 +957,6 @@ export const TRADABLE_PAIRS = {
                 },
             ],
         },
-        {
-            id: 'USDC-cGHS',
-            assets: [
-                {
-                    address: '0xcebA9300f2b948710d2653dD7B07f33A8B32118C',
-                    symbol: 'USDC',
-                },
-                {
-                    address: '0xfAeA5F3404bbA20D3cc2f8C4B0A888F55a3c7313',
-                    symbol: 'cGHS',
-                },
-            ],
-            path: [
-                {
-                    providerAddr: '0x22d9db95E6Ae61c104A7B6F6C78D7993B94ec901',
-                    id: '0xacc988382b66ee5456086643dcfd9a5ca43dd8f428f6ef22503d8b8013bcffd7',
-                    assets: [
-                        '0x765DE816845861e75A25fCA122bb6898B8B1282a',
-                        '0xcebA9300f2b948710d2653dD7B07f33A8B32118C',
-                    ],
-                },
-                {
-                    providerAddr: '0x22d9db95E6Ae61c104A7B6F6C78D7993B94ec901',
-                    id: '0x3562f9d29eba092b857480a82b03375839c752346b9ebe93a57ab82410328187',
-                    assets: [
-                        '0x765DE816845861e75A25fCA122bb6898B8B1282a',
-                        '0xfAeA5F3404bbA20D3cc2f8C4B0A888F55a3c7313',
-                    ],
-                },
-            ],
-        },
         {
             id: 'axlEUROC-axlUSDC',
             assets: [
@@ -1197,37 +1112,6 @@ export const TRADABLE_PAIRS = {
                 },
             ],
         },
-        {
-            id: 'axlUSDC-cGHS',
-            assets: [
-                {
-                    address: '0xEB466342C4d449BC9f53A865D5Cb90586f405215',
-                    symbol: 'axlUSDC',
-                },
-                {
-                    address: '0xfAeA5F3404bbA20D3cc2f8C4B0A888F55a3c7313',
-                    symbol: 'cGHS',
-                },
-            ],
-            path: [
-                {
-                    providerAddr: '0x22d9db95E6Ae61c104A7B6F6C78D7993B94ec901',
-                    id: '0x0d739efbfc30f303e8d1976c213b4040850d1af40f174f4169b846f6fd3d2f20',
-                    assets: [
-                        '0x765DE816845861e75A25fCA122bb6898B8B1282a',
-                        '0xEB466342C4d449BC9f53A865D5Cb90586f405215',
-                    ],
-                },
-                {
-                    providerAddr: '0x22d9db95E6Ae61c104A7B6F6C78D7993B94ec901',
-                    id: '0x3562f9d29eba092b857480a82b03375839c752346b9ebe93a57ab82410328187',
-                    assets: [
-                        '0x765DE816845861e75A25fCA122bb6898B8B1282a',
-                        '0xfAeA5F3404bbA20D3cc2f8C4B0A888F55a3c7313',
-                    ],
-                },
-            ],
-        },
         {
             id: 'USD₮-cKES',
             assets: [
@@ -1321,37 +1205,6 @@ export const TRADABLE_PAIRS = {
                 },
             ],
         },
-        {
-            id: 'cGHS-cKES',
-            assets: [
-                {
-                    address: '0xfAeA5F3404bbA20D3cc2f8C4B0A888F55a3c7313',
-                    symbol: 'cGHS',
-                },
-                {
-                    address: '0x456a3D042C0DbD3db53D5489e98dFb038553B0d0',
-                    symbol: 'cKES',
-                },
-            ],
-            path: [
-                {
-                    providerAddr: '0x22d9db95E6Ae61c104A7B6F6C78D7993B94ec901',
-                    id: '0x89de88b8eb790de26f4649f543cb6893d93635c728ac857f0926e842fb0d298b',
-                    assets: [
-                        '0x765DE816845861e75A25fCA122bb6898B8B1282a',
-                        '0x456a3D042C0DbD3db53D5489e98dFb038553B0d0',
-                    ],
-                },
-                {
-                    providerAddr: '0x22d9db95E6Ae61c104A7B6F6C78D7993B94ec901',
-                    id: '0x3562f9d29eba092b857480a82b03375839c752346b9ebe93a57ab82410328187',
-                    assets: [
-                        '0x765DE816845861e75A25fCA122bb6898B8B1282a',
-                        '0xfAeA5F3404bbA20D3cc2f8C4B0A888F55a3c7313',
-                    ],
-                },
-            ],
-        },
         {
             id: 'PUSO-USD₮',
             assets: [
@@ -1414,37 +1267,6 @@ export const TRADABLE_PAIRS = {
                 },
             ],
         },
-        {
-            id: 'USD₮-cGHS',
-            assets: [
-                {
-                    address: '0x48065fbBE25f71C9282ddf5e1cD6D6A887483D5e',
-                    symbol: 'USD₮',
-                },
-                {
-                    address: '0xfAeA5F3404bbA20D3cc2f8C4B0A888F55a3c7313',
-                    symbol: 'cGHS',
-                },
-            ],
-            path: [
-                {
-                    providerAddr: '0x22d9db95E6Ae61c104A7B6F6C78D7993B94ec901',
-                    id: '0x773bcec109cee923b5e04706044fd9d6a5121b1a6a4c059c36fdbe5b845d4e9b',
-                    assets: [
-                        '0x765DE816845861e75A25fCA122bb6898B8B1282a',
-                        '0x48065fbBE25f71C9282ddf5e1cD6D6A887483D5e',
-                    ],
-                },
-                {
-                    providerAddr: '0x22d9db95E6Ae61c104A7B6F6C78D7993B94ec901',
-                    id: '0x3562f9d29eba092b857480a82b03375839c752346b9ebe93a57ab82410328187',
-                    assets: [
-                        '0x765DE816845861e75A25fCA122bb6898B8B1282a',
-                        '0xfAeA5F3404bbA20D3cc2f8C4B0A888F55a3c7313',
-                    ],
-                },
-            ],
-        },
         {
             id: 'PUSO-cCOP',
             assets: [
@@ -1476,68 +1298,6 @@ export const TRADABLE_PAIRS = {
                 },
             ],
         },
-        {
-            id: 'PUSO-cGHS',
-            assets: [
-                {
-                    address: '0x105d4A9306D2E55a71d2Eb95B81553AE1dC20d7B',
-                    symbol: 'PUSO',
-                },
-                {
-                    address: '0xfAeA5F3404bbA20D3cc2f8C4B0A888F55a3c7313',
-                    symbol: 'cGHS',
-                },
-            ],
-            path: [
-                {
-                    providerAddr: '0x22d9db95E6Ae61c104A7B6F6C78D7993B94ec901',
-                    id: '0x7952984d7278ca3417febf52815c321984ac3147ced2c02bb6a02b0bcab08413',
-                    assets: [
-                        '0x765DE816845861e75A25fCA122bb6898B8B1282a',
-                        '0x105d4A9306D2E55a71d2Eb95B81553AE1dC20d7B',
-                    ],
-                },
-                {
-                    providerAddr: '0x22d9db95E6Ae61c104A7B6F6C78D7993B94ec901',
-                    id: '0x3562f9d29eba092b857480a82b03375839c752346b9ebe93a57ab82410328187',
-                    assets: [
-                        '0x765DE816845861e75A25fCA122bb6898B8B1282a',
-                        '0xfAeA5F3404bbA20D3cc2f8C4B0A888F55a3c7313',
-                    ],
-                },
-            ],
-        },
-        {
-            id: 'cCOP-cGHS',
-            assets: [
-                {
-                    address: '0x8A567e2aE79CA692Bd748aB832081C45de4041eA',
-                    symbol: 'cCOP',
-                },
-                {
-                    address: '0xfAeA5F3404bbA20D3cc2f8C4B0A888F55a3c7313',
-                    symbol: 'cGHS',
-                },
-            ],
-            path: [
-                {
-                    providerAddr: '0x22d9db95E6Ae61c104A7B6F6C78D7993B94ec901',
-                    id: '0x1c9378bd0973ff313a599d3effc654ba759f8ccca655ab6d6ce5bd39a212943b',
-                    assets: [
-                        '0x765DE816845861e75A25fCA122bb6898B8B1282a',
-                        '0x8A567e2aE79CA692Bd748aB832081C45de4041eA',
-                    ],
-                },
-                {
-                    providerAddr: '0x22d9db95E6Ae61c104A7B6F6C78D7993B94ec901',
-                    id: '0x3562f9d29eba092b857480a82b03375839c752346b9ebe93a57ab82410328187',
-                    assets: [
-                        '0x765DE816845861e75A25fCA122bb6898B8B1282a',
-                        '0xfAeA5F3404bbA20D3cc2f8C4B0A888F55a3c7313',
-                    ],
-                },
-            ],
-        },
     ],
     '44787': [
         {

package/dist/esm/mento.d.ts

@@ -1,6 +1,6 @@
+import { Address, TradingLimit, TradingLimitsConfig, TradingLimitsState } from './interfaces';
 import { IBroker } from '@mento-protocol/mento-core-ts';
 import { BigNumber, BigNumberish, Signer, providers } from 'ethers';
-import { Address, TradingLimit, TradingLimitsConfig, TradingLimitsState } from './interfaces';
 export interface Exchange {
     providerAddr: Address;
     id: string;
@@ -58,9 +58,7 @@ export declare class Mento {
      * Get tradable pairs for backwards compatibility
      * @returns an array of Asset pairs
      */
-    getTradablePairs(options?: {
-        cached?: boolean;
-    }): Promise<[Asset, Asset][]>;
+    getTradablePairs(cached?: boolean): Promise<[Asset, Asset][]>;
     /**
      * Returns a list of all tradable pairs on Mento via direct exchanges.
      * Each pair is represented using the TradablePair interface, with its id
@@ -76,9 +74,7 @@ export declare class Mento {
      * the two Asset objects, and an array of exchange details for each hop.
      * @returns An array of TradablePair objects representing available trade routes.
      */
-    getTradablePairsWithPath(options?: {
-        cached?: boolean;
-    }): Promise<readonly TradablePair[]>;
+    getTradablePairsWithPath(cached?: boolean): Promise<readonly TradablePair[]>;
     /**
      * Returns the amount of tokenIn to be sold to buy amountOut of tokenOut.
      * If the provided tradablePair has a single (direct) pricing path, then direct pricing is used.

package/dist/esm/mento.js

@@ -9,12 +9,12 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 import { BiPoolManager__factory, Broker__factory, IBreakerBox__factory, IBroker__factory, IExchangeProvider__factory, } from '@mento-protocol/mento-core-ts';
 import { Signer } from 'ethers';
-import { getLimits, getLimitsConfig, getLimitsState } from './limits';
 import { getBrokerAddressFromRegistry, getChainId, getSymbolFromTokenAddress, increaseAllowance, validateSigner, validateSignerOrProvider, } from './utils';
+import { getLimits, getLimitsConfig, getLimitsState } from './limits';
 import { strict as assert } from 'assert';
+import { getCachedTradablePairs } from './constants/tradablePairs';
 import { IMentoRouter__factory } from 'mento-router-ts';
 import { getAddress } from './constants/addresses';
-import { getCachedTradablePairs } from './constants/tradablePairs';
 export class Mento {
     /**
      * This constructor is private, use the static create or createWithParams methods
@@ -66,10 +66,9 @@ export class Mento {
      * Get tradable pairs for backwards compatibility
      * @returns an array of Asset pairs
      */
-    getTradablePairs(options) {
-        var _a;
+    getTradablePairs(cached = true) {
         return __awaiter(this, void 0, void 0, function* () {
-            return (yield this.getTradablePairsWithPath({ cached: (_a = options === null || options === void 0 ? void 0 : options.cached) !== null && _a !== void 0 ? _a : true })).map((pair) => pair.assets);
+            return (yield this.getTradablePairsWithPath(cached)).map((pair) => pair.assets);
         });
     }
     /**
@@ -129,10 +128,10 @@ export class Mento {
      * the two Asset objects, and an array of exchange details for each hop.
      * @returns An array of TradablePair objects representing available trade routes.
      */
-    getTradablePairsWithPath(options) {
+    getTradablePairsWithPath(cached = true) {
         return __awaiter(this, void 0, void 0, function* () {
             // Get tradable pairs from cache if available.
-            if (options === null || options === void 0 ? void 0 : options.cached) {
+            if (cached) {
                 const value = getCachedTradablePairs(yield getChainId(this.signerOrProvider));
                 if (value) {
                     return value;
@@ -305,9 +304,7 @@ export class Mento {
      */
     increaseTradingAllowance(tokenIn, amount, tradablePair) {
         return __awaiter(this, void 0, void 0, function* () {
-            const spender = !tradablePair || (tradablePair === null || tradablePair === void 0 ? void 0 : tradablePair.path.length) == 1
-                ? this.broker.address
-                : this.router.address;
+            const spender = !tradablePair || (tradablePair === null || tradablePair === void 0 ? void 0 : tradablePair.path.length) == 1 ? this.broker.address : this.router.address;
             const tx = yield increaseAllowance(tokenIn, spender, amount, this.signerOrProvider);
             if (Signer.isSigner(this.signerOrProvider)) {
                 // The contract call doesn't populate all of the signer fields, so we need an extra call for the signer
@@ -458,15 +455,11 @@ export class Mento {
         return __awaiter(this, void 0, void 0, function* () {
             const pair = (yield this.getTradablePairsWithPath()).find((p) => 
             // Direct path
-            (p.path.length === 1 &&
-                p.path[0].assets.includes(tokenIn) &&
-                p.path[0].assets.includes(tokenOut)) ||
+            (p.path.length === 1 && p.path[0].assets.includes(tokenIn) && p.path[0].assets.includes(tokenOut)) ||
                 // Routed path
                 (p.path.length === 2 &&
-                    ((p.path[0].assets.includes(tokenIn) &&
-                        p.path[1].assets.includes(tokenOut)) ||
-                        (p.path[0].assets.includes(tokenOut) &&
-                            p.path[1].assets.includes(tokenIn)))));
+                    ((p.path[0].assets.includes(tokenIn) && p.path[1].assets.includes(tokenOut)) ||
+                        (p.path[0].assets.includes(tokenOut) && p.path[1].assets.includes(tokenIn)))));
             if (!pair) {
                 throw new Error(`No tradable pair found for tokens ${tokenIn} and ${tokenOut}`);
             }

package/dist/index.d.ts

@@ -0,0 +1,67 @@
+import type { PublicClient } from 'viem';
+import type { Provider as EthersV6Provider } from 'ethers';
+import type { providers as EthersV5Providers } from 'ethers-v5';
+import { CollateralAsset, ContractAddresses, StableToken } from './types';
+export type SupportedProvider = EthersV6Provider | PublicClient | EthersV5Providers.Provider;
+export interface MentoConfig {
+    /** Provider can be one of:
+     * - Ethers v6 Provider (from 'ethers')
+     * - Ethers v5 Provider (from 'ethers-v5')
+     * - Viem PublicClient (from 'viem')
+     */
+    provider: SupportedProvider;
+}
+/**
+ * @class Mento
+ * @description The main class for the Mento SDK. It initializes the provider and services,
+ *              and provides a public API for interacting with the Mento Protocol.
+ * @dev         example usage:
+ *              // Ethers v6
+ *              const mento = await Mento.create({
+ *                provider: new ethers.JsonRpcProvider("https://forno.celo.org")
+ *              });
+ *
+ *              // Ethers v5
+ *              const mento = await Mento.create({
+ *                provider: new ethersV5.providers.JsonRpcProvider("https://forno.celo.org")
+ *              });
+ *
+ *              // Viem
+ *              const mento = await Mento.create({
+ *                provider: createPublicClient({
+ *                  transport: http("https://forno.celo.org")
+ *                })
+ *              });
+ *
+ *              // Get all stable tokens
+ *              const stableTokens = await mento.getStableTokens();
+ *
+ *              // Get all collateral assets
+ *              const collateralAssets = await mento.getCollateralAssets();
+ */
+export declare class Mento {
+    private provider;
+    private stableTokenService;
+    private collateralAssetService;
+    private constructor();
+    static create(config: MentoConfig): Promise<Mento>;
+    getStableTokens(): Promise<StableToken[]>;
+    /**
+     * Get all collateral assets that are available on the current chain.
+     * @returns An array of collateral assets
+     */
+    getCollateralAssets(): Promise<CollateralAsset[]>;
+    /**
+     * Get the address of a contract for the current chain
+     * @param contractName - The contract name
+     * @returns The contract address
+     */
+    getContractAddress(contractName: keyof ContractAddresses): Promise<string>;
+}
+export * from './constants';
+export * from './types';
+export * from './adapters';
+export * from './services';
+export * from './abis';
+export * from './utils';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,MAAM,CAAA;AACxC,OAAO,KAAK,EAAE,QAAQ,IAAI,gBAAgB,EAAE,MAAM,QAAQ,CAAA;AAC1D,OAAO,KAAK,EAAE,SAAS,IAAI,iBAAiB,EAAE,MAAM,WAAW,CAAA;AAG/D,OAAO,EACL,eAAe,EACf,iBAAiB,EAEjB,WAAW,EACZ,MAAM,SAAS,CAAA;AAKhB,MAAM,MAAM,iBAAiB,GACzB,gBAAgB,GAChB,YAAY,GACZ,iBAAiB,CAAC,QAAQ,CAAA;AAE9B,MAAM,WAAW,WAAW;IAC1B;;;;OAIG;IACH,QAAQ,EAAE,iBAAiB,CAAA;CAC5B;AAgCD;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,qBAAa,KAAK;IAChB,OAAO,CAAC,QAAQ,CAAiB;IACjC,OAAO,CAAC,kBAAkB,CAAoB;IAC9C,OAAO,CAAC,sBAAsB,CAAwB;IAEtD,OAAO;WAUa,MAAM,CAAC,MAAM,EAAE,WAAW,GAAG,OAAO,CAAC,KAAK,CAAC;IAsBlD,eAAe,IAAI,OAAO,CAAC,WAAW,EAAE,CAAC;IAItD;;;OAGG;IACU,mBAAmB,IAAI,OAAO,CAAC,eAAe,EAAE,CAAC;IAI9D;;;;OAIG;IACU,kBAAkB,CAC7B,YAAY,EAAE,MAAM,iBAAiB,GACpC,OAAO,CAAC,MAAM,CAAC;CAInB;AAED,cAAc,aAAa,CAAA;AAC3B,cAAc,SAAS,CAAA;AACvB,cAAc,YAAY,CAAA;AAC1B,cAAc,YAAY,CAAA;AAC1B,cAAc,QAAQ,CAAA;AACtB,cAAc,SAAS,CAAA"}