@mento-protocol/mento-sdk 1.10.2 → 2.0.0-beta.10

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@mento-protocol/mento-sdk",
   "description": "Official SDK for interacting with the Mento Protocol",
-  "version": "1.10.2",
+  "version": "2.0.0-beta.10",
   "license": "MIT",
   "author": "Mento Labs",
   "keywords": [
@@ -13,89 +13,61 @@
     "type": "git",
     "url": "https://github.com/mento-protocol/mento-sdk.git"
   },
-  "main": "dist/cjs/index.js",
-  "module": "dist/esm/index.js",
-  "typings": "dist/esm/index.d.ts",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
   "files": [
     "dist",
     "!dist/**/*.test.*"
   ],
+  "type": "commonjs",
   "scripts": {
-    "analyze": "size-limit --why",
-    "build": "yarn build:cjs && yarn build:esm",
-    "build:cjs": "tsc --project ./tsconfig.json",
-    "build:esm": "tsc --project ./tsconfig.esm.json",
+    "build": "pnpm clean && tsc --project ./tsconfig.json",
     "clean": "rm -rf ./dist",
-    "lint": "eslint --config ./.eslintrc.json 'src/**/*.ts' 'scripts/**/*.ts'",
-    "type-check": "tsc --noEmit --project ./tsconfig.eslint.json",
+    "lint": "eslint --config ./.eslintrc.json src/**/*.ts",
     "prettier": "prettier --config ./.prettierrc.json --write **/*.{json,md,js,ts,yml}",
-    "size": "size-limit",
-    "test": "jest --runInBand --verbose",
-    "coverage": "jest --coverage",
-    "cacheTradablePairs": "ts-node scripts/cacheTradablePairs.ts",
-    "printTradablePairs": "ts-node scripts/printTradablePairs.ts",
-    "tradingLimits": "ts-node scripts/printTradingLimits.ts",
-    "poolConfigs": "ts-node scripts/printPoolConfigs.ts",
-    "breakerBox": "ts-node scripts/printBreakerBox.ts",
-    "quote": "ts-node scripts/quotes/index.ts",
-    "getTokenGraph": "ts-node scripts/visualizeTokenGraph.ts"
-  },
-  "husky": {
-    "hooks": {
-      "pre-commit": "yarn lint"
-    }
-  },
-  "jest": {
-    "testEnvironment": "node",
-    "testMatch": [
-      "**/?(*.)+(test).ts"
-    ]
+    "test": "jest --verbose",
+    "coverage": "jest --coverage"
   },
   "engines": {
-    "node": ">=22"
+    "node": ">=18",
+    "pnpm": ">=9"
   },
-  "size-limit": [
-    {
-      "path": "dist/sdk.cjs.production.min.js",
-      "limit": "10 KB"
-    },
-    {
-      "path": "dist/sdk.esm.js",
-      "limit": "10 KB"
-    }
-  ],
   "devDependencies": {
-    "@babel/preset-env": "^7.20.2",
-    "@babel/preset-typescript": "^7.18.6",
+    "@jest/types": "^29.6.3",
     "@size-limit/preset-small-lib": "^8.1.0",
     "@tsconfig/recommended": "^1.0.1",
-    "@types/jest": "^29.4.0",
-    "@types/node": "^22.13.0",
-    "@types/yargs-parser": "^21.0.3",
+    "@types/jest": "^29.5.14",
+    "@types/node": "^18.13.0",
     "@typescript-eslint/eslint-plugin": "^5.53.0",
     "@typescript-eslint/parser": "^5.53.0",
-    "chalk": "4.1.2",
-    "cli-table3": "0.6.3",
-    "date-fns": "^4.1.0",
     "eslint": "^8.34.0",
     "eslint-config-prettier": "^8.6.0",
-    "ethers": "^5.7",
     "husky": "^8.0.2",
     "jest": "^29.4.2",
-    "ora": "8.2.0",
     "prettier": "^2.8.4",
-    "size-limit": "^8.1.0",
     "ts-jest": "^29.0.5",
     "ts-node": "^10.9.1",
-    "typescript": "^4.9.5",
-    "yargs-parser": "^21.1.1"
-  },
-  "dependencies": {
-    "@mento-protocol/mento-core-ts": "^0.2.0",
-    "mento-router-ts": "^0.2.0"
+    "typescript": "5.6.3"
   },
   "peerDependencies": {
-    "ethers": "^5.7"
+    "ethers": "^6.13.4",
+    "ethers-v5": "npm:ethers@^5.7",
+    "viem": "^2.21.44"
   },
-  "packageManager": "yarn@3.3.1"
+  "peerDependenciesMeta": {
+    "ethers": {
+      "optional": true
+    },
+    "ethers-v5": {
+      "optional": true
+    },
+    "viem": {
+      "optional": true
+    }
+  },
+  "dependencies": {
+    "@mento-protocol/mento-core-ts": "^0.2.0",
+    "bignumber.js": "^9.1.2",
+    "dotenv": "^16.4.5"
+  }
 }

package/dist/cjs/ChainClient.d.ts

@@ -1,9 +0,0 @@
-import { PopulatedTransaction, ethers, providers } from 'ethers';
-import { IChainClient } from './interfaces';
-export declare class ChainClient implements IChainClient {
-    private readonly signerOrProvider;
-    constructor(signerOrProvider: ethers.Signer | providers.Provider);
-    getSigner(): Promise<ethers.Signer | providers.Provider>;
-    getChainId(): Promise<number>;
-    populateTransaction(tx: PopulatedTransaction): Promise<providers.TransactionRequest>;
-}

package/dist/cjs/ChainClient.js

@@ -1,58 +0,0 @@
-"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());
-    });
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ChainClient = void 0;
-const ethers_1 = require("ethers");
-const utils_1 = require("./utils");
-class ChainClient {
-    constructor(signerOrProvider) {
-        (0, utils_1.validateSignerOrProvider)(signerOrProvider);
-        this.signerOrProvider = signerOrProvider;
-    }
-    getSigner() {
-        return __awaiter(this, void 0, void 0, function* () {
-            return this.signerOrProvider;
-        });
-    }
-    getChainId() {
-        var _a;
-        return __awaiter(this, void 0, void 0, function* () {
-            let chainId = 0;
-            if (ethers_1.Signer.isSigner(this.signerOrProvider)) {
-                const network = yield ((_a = this.signerOrProvider.provider) === null || _a === void 0 ? void 0 : _a.getNetwork());
-                if (network) {
-                    chainId = network.chainId;
-                }
-            }
-            else if (ethers_1.providers.Provider.isProvider(this.signerOrProvider)) {
-                const network = yield this.signerOrProvider.getNetwork();
-                if (network) {
-                    chainId = network.chainId;
-                }
-            }
-            if (chainId === 0) {
-                throw new Error('Could not get chainId from signer or provider');
-            }
-            return chainId;
-        });
-    }
-    populateTransaction(tx) {
-        return __awaiter(this, void 0, void 0, function* () {
-            if (ethers_1.Signer.isSigner(this.signerOrProvider)) {
-                return this.signerOrProvider.populateTransaction(tx);
-            }
-            else {
-                return tx;
-            }
-        });
-    }
-}
-exports.ChainClient = ChainClient;

package/dist/cjs/TestChainClient.d.ts

@@ -1,7 +0,0 @@
-import { PopulatedTransaction, ethers, providers } from 'ethers';
-import { IChainClient } from './interfaces';
-export declare class TestChainClient implements IChainClient {
-    getSigner(): Promise<ethers.Signer | providers.Provider>;
-    getChainId(): Promise<number>;
-    populateTransaction(tx: PopulatedTransaction): Promise<providers.TransactionRequest>;
-}

package/dist/cjs/TestChainClient.js

@@ -1,41 +0,0 @@
-"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());
-    });
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.TestChainClient = void 0;
-class TestChainClient {
-    getSigner() {
-        return __awaiter(this, void 0, void 0, function* () {
-            const fakeProvider = {};
-            return fakeProvider;
-        });
-    }
-    getChainId() {
-        return __awaiter(this, void 0, void 0, function* () {
-            return 44787;
-        });
-    }
-    populateTransaction(tx) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const fakeTx = {
-                to: tx.to,
-                from: tx.from,
-                data: tx.data,
-                value: tx.value,
-                nonce: 0,
-                gasLimit: 0,
-                gasPrice: 0,
-                chainId: 1,
-            };
-            return fakeTx;
-        });
-    }
-}
-exports.TestChainClient = TestChainClient;

package/dist/cjs/constants/addresses.d.ts

@@ -1,4 +0,0 @@
-import { ContractAddressMap } from '../types';
-export declare const addresses: ContractAddressMap;
-export type Identifier = keyof ContractAddressMap[keyof ContractAddressMap];
-export declare function getAddress(identifier: Identifier, chainId: number): string;

package/dist/cjs/constants/addresses.js

@@ -1,64 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getAddress = exports.addresses = void 0;
-const enums_1 = require("./../enums");
-exports.addresses = {
-    [enums_1.ChainId.CELO]: {
-        GovernanceFactory: '0xee6CE2dbe788dFC38b8F583Da86cB9caf2C8cF5A',
-        Airgrab: '0x7D8E73deafDBAfc98fDBe7974168cFA6d8B9AE0C',
-        Emission: '0x5C789592E2611df1873b46D394c69f75faB99778',
-        MentoGovernor: '0x47036d78bB3169b4F5560dD77BF93f4412A59852',
-        MentoToken: '0x7FF62f59e3e89EA34163EA1458EEBCc81177Cfb6',
-        TimelockController: '0x890DB8A597940165901372Dd7DB61C9f246e2147',
-        Locking: '0x001Bb66636dCd149A1A2bA8C50E408BdDd80279C',
-        MentoRouter: '0xbe729350f8cdfc19db6866e8579841188ee57f67',
-        Broker: '0x777A8255cA72412f0d706dc03C9D1987306B4CaD',
-        BiPoolManager: '0x22d9db95E6Ae61c104A7B6F6C78D7993B94ec901',
-        BreakerBox: '0x303ED1df62Fa067659B586EbEe8De0EcE824Ab39',
-        Reserve: '0x9380fA34Fd9e4Fd14c06305fd7B6199089eD4eb9',
-        ConstantSumPricingModule: '0xDebED1F6f6ce9F6e73AA25F95acBFFE2397550Fb',
-        ConstantProductPricingModule: '0x0c07126d0CB30E66eF7553Cc7C37143B4f06DddB',
-        MedianDeltaBreaker: '0x49349F92D2B17d491e42C8fdB02D19f072F9B5D9',
-        ValueDeltaBreaker: '0x4DBC33B3abA78475A5AA4BC7A5B11445d387BF68',
-        StableToken: '0x765DE816845861e75A25fCA122bb6898B8B1282a',
-        StableTokenEUR: '0xD8763CBa276a3738E6DE85b4b3bF5FDed6D6cA73',
-        StableTokenBRL: '0xe8537a3d056DA446677B9E9d6c5dB704EaAb4787',
-        StableTokenXOF: '0x73F93dcc49cB8A239e2032663e9475dd5ef29A08',
-        SortedOracles: '0xefB84935239dAcdecF7c5bA76d8dE40b077B7b33',
-    },
-    [enums_1.ChainId.ALFAJORES]: {
-        GovernanceFactory: '0x96Fe03DBFEc1EB419885a01d2335bE7c1a45e33b',
-        Airgrab: '0x8dC9282F0a74A2a36F41440e009AA0EADFe490c5',
-        Emission: '0xe62cc88ca2A5E7Dd3Fe5ce8511C874e610Ddb0b6',
-        MentoGovernor: '0x558e92236f85Bb4e8A63ec0D5Bf9d34087Eab744',
-        MentoToken: '0x3eDd2f7c90e2E931c817a44302Af7112E84be6Cc',
-        TimelockController: '0xa0Ad8DD40104556122c21dF50eD14bb1B53A3338',
-        Locking: '0x537CaE97C588C6DA64A385817F3D3563DDCf0591',
-        MentoRouter: '0xe6101a457a69b53e298e35a7f6e3dcb0390df02a',
-        Broker: '0xD3Dff18E465bCa6241A244144765b4421Ac14D09',
-        BiPoolManager: '0x9B64E8EaBD1a035b148cE970d3319c5C3Ad53EC3',
-        BreakerBox: '0xC76BDf0AFb654888728003683cf748A8B1b4f5fD',
-        Reserve: '0xa7ed835288Aa4524bB6C73DD23c0bF4315D9Fe3e',
-        ConstantSumPricingModule: '0x474DBf1eDF845410bdaC6aeE97C3CC403651ba2E',
-        ConstantProductPricingModule: '0x99EDce8143FF8AeFA1fBB6C2103B349Add2B9519',
-        MedianDeltaBreaker: '0x6B0a2076713fDAef4F9301fe8404a228e3682DE4',
-        ValueDeltaBreaker: '0xfa6fFf746a5E74055e432f3bba26138956AEfbFe',
-        StableToken: '0x874069Fa1Eb16D44d622F2e0Ca25eeA172369bC1',
-        StableTokenEUR: '0x10c892A6EC43a53E45D0B916B4b7D383B1b78C0F',
-        StableTokenBRL: '0xE4D517785D091D3c54818832dB6094bcc2744545',
-        StableTokenXOF: '0xB0FA15e002516d0301884059c0aaC0F0C72b019D',
-        SortedOracles: '0xFdd8bD58115FfBf04e47411c1d228eCC45E93075',
-    },
-};
-function getAddress(identifier, chainId) {
-    const addressesForChain = exports.addresses[chainId];
-    if (!addressesForChain) {
-        throw new Error(`No addresses found for chain ID ${chainId}`);
-    }
-    const address = addressesForChain[identifier];
-    if (!address) {
-        throw new Error(`Address not found for identifier ${identifier} on chain ID ${chainId}`);
-    }
-    return address;
-}
-exports.getAddress = getAddress;

package/dist/cjs/constants/index.d.ts

@@ -1,2 +0,0 @@
-export * from './addresses';
-export * from './tradablePairs';

package/dist/cjs/constants/tradablePairs.42220.d.ts

@@ -1,2 +0,0 @@
-import { TradablePairWithSpread } from './tradablePairs';
-export declare const tradablePairs42220: TradablePairWithSpread[];