@mento-protocol/mento-sdk 0.1.3 → 0.1.4

package/dist/cjs/mento.d.ts

@@ -1,5 +1,5 @@
 import { IBroker } from '@mento-protocol/mento-core-ts';
-import { BigNumber, providers, Signer } from 'ethers';
+import { BigNumber, BigNumberish, providers, Signer } from 'ethers';
 import { Address } from './types';
 export interface Exchange {
     providerAddr: Address;
@@ -56,7 +56,7 @@ export declare class Mento {
      * @param amountOut the amount of tokenOut to be bought
      * @returns the amount of tokenIn to be sold
      */
-    getAmountIn(tokenIn: Address, tokenOut: Address, amountOut: BigNumber): Promise<BigNumber>;
+    getAmountIn(tokenIn: Address, tokenOut: Address, amountOut: BigNumberish): Promise<BigNumber>;
     /**
      * Returns the amount of tokenOut to be bought by selling amountIn of tokenIn
      * @param tokenIn the token to be sold
@@ -64,14 +64,14 @@ export declare class Mento {
      * @param amountIn the amount of tokenIn to be sold
      * @returns the amount of tokenOut to be bought
      */
-    getAmountOut(tokenIn: Address, tokenOut: Address, amountIn: BigNumber): Promise<BigNumber>;
+    getAmountOut(tokenIn: Address, tokenOut: Address, amountIn: BigNumberish): Promise<BigNumber>;
     /**
      * Increases the broker's trading allowance for the given token
      * @param token the token to increase the allowance for
      * @param amount the amount to increase the allowance by
      * @returns the populated TransactionRequest object
      */
-    increaseTradingAllowance(token: Address, amount: BigNumber): Promise<providers.TransactionRequest>;
+    increaseTradingAllowance(token: Address, amount: BigNumberish): Promise<providers.TransactionRequest>;
     /**
      * Returns a token swap populated tx object with a fixed amount of tokenIn and a minimum amount of tokenOut
      * Submitting the transaction to execute the swap is left to the consumer
@@ -81,7 +81,7 @@ export declare class Mento {
      * @param amountOutMin the minimum amount of tokenOut to be bought
      * @returns the populated TransactionRequest object
      */
-    swapIn(tokenIn: Address, tokenOut: Address, amountIn: BigNumber, amountOutMin: BigNumber): Promise<providers.TransactionRequest>;
+    swapIn(tokenIn: Address, tokenOut: Address, amountIn: BigNumberish, amountOutMin: BigNumberish): Promise<providers.TransactionRequest>;
     /**
      * Returns a token swap populated tx object with a maximum amount of tokenIn and a fixed amount of tokenOut
      * Submitting the transaction to execute the swap is left to the consumer
@@ -91,7 +91,7 @@ export declare class Mento {
      * @param amountInMax the maximum amount of tokenIn to be sold
      * @returns the populated TransactionRequest object
      */
-    swapOut(tokenIn: Address, tokenOut: Address, amountOut: BigNumber, amountInMax: BigNumber): Promise<providers.TransactionRequest>;
+    swapOut(tokenIn: Address, tokenOut: Address, amountOut: BigNumberish, amountInMax: BigNumberish): Promise<providers.TransactionRequest>;
     /**
      * Returns the mento instance's broker contract
      * @returns broker contract

package/dist/cjs/mento.js

@@ -117,13 +117,15 @@ class Mento {
      */
     increaseTradingAllowance(token, amount) {
         return __awaiter(this, void 0, void 0, function* () {
-            if (!ethers_1.Signer.isSigner(this.signerOrProvider)) {
-                throw new Error('A signer is required to populate the increaseAllowance tx object');
-            }
             const spender = this.broker.address;
             const tx = yield (0, utils_1.increaseAllowance)(token, spender, amount, this.signerOrProvider);
-            // The contract call doesn't populate all of the signer fields, so we need an extra call for the signer
-            return this.signerOrProvider.populateTransaction(tx);
+            if (ethers_1.Signer.isSigner(this.signerOrProvider)) {
+                // The contract call doesn't populate all of the signer fields, so we need an extra call for the signer
+                return this.signerOrProvider.populateTransaction(tx);
+            }
+            else {
+                return tx;
+            }
         });
     }
     /**
@@ -137,13 +139,15 @@ class Mento {
      */
     swapIn(tokenIn, tokenOut, amountIn, amountOutMin) {
         return __awaiter(this, void 0, void 0, function* () {
-            if (!ethers_1.Signer.isSigner(this.signerOrProvider)) {
-                throw new Error('A signer is required to populate the swapIn tx object');
-            }
             const exchange = yield this.getExchangeForTokens(tokenIn, tokenOut);
             const tx = yield this.broker.populateTransaction.swapIn(exchange.providerAddr, exchange.id, tokenIn, tokenOut, amountIn, amountOutMin);
-            // The broker's call doesn't populate all of the signer fields, so we need an extra call for the signer
-            return this.signerOrProvider.populateTransaction(tx);
+            if (ethers_1.Signer.isSigner(this.signerOrProvider)) {
+                // The contract call doesn't populate all of the signer fields, so we need an extra call for the signer
+                return this.signerOrProvider.populateTransaction(tx);
+            }
+            else {
+                return tx;
+            }
         });
     }
     /**
@@ -157,13 +161,15 @@ class Mento {
      */
     swapOut(tokenIn, tokenOut, amountOut, amountInMax) {
         return __awaiter(this, void 0, void 0, function* () {
-            if (!ethers_1.Signer.isSigner(this.signerOrProvider)) {
-                throw new Error('A signer is required to populate the swapOut tx object');
-            }
             const exchange = yield this.getExchangeForTokens(tokenIn, tokenOut);
             const tx = yield this.broker.populateTransaction.swapOut(exchange.providerAddr, exchange.id, tokenIn, tokenOut, amountOut, amountInMax);
-            // The broker's call doesn't populate all of the signer fields, so we need an extra call for the signer
-            return this.signerOrProvider.populateTransaction(tx);
+            if (ethers_1.Signer.isSigner(this.signerOrProvider)) {
+                // The contract call doesn't populate all of the signer fields, so we need an extra call for the signer
+                return this.signerOrProvider.populateTransaction(tx);
+            }
+            else {
+                return tx;
+            }
         });
     }
     /**

package/dist/cjs/utils.d.ts

@@ -1,4 +1,4 @@
-import { BigNumber, providers, Signer } from 'ethers';
+import { BigNumberish, providers, Signer } from 'ethers';
 import { Address } from './types';
 /**
  * Ensures that given signer is truly a a connected signer
@@ -30,7 +30,7 @@ export declare function getSymbolFromTokenAddress(tokenAddr: Address, signerOrPr
  * @param tokenAddr the address of the erc20 token
  * @param spender the address of the spender
  * @param amount the amount to increase the allowance by
- * @param signer an ethers signer
+ * @param signerOrProvider an ethers signer or provider
  * @returns the populated TransactionRequest object
  */
-export declare function increaseAllowance(tokenAddr: string, spender: string, amount: BigNumber, signer: Signer): Promise<providers.TransactionRequest>;
+export declare function increaseAllowance(tokenAddr: string, spender: string, amount: BigNumberish, signerOrProvider: Signer | providers.Provider): Promise<providers.TransactionRequest>;

package/dist/cjs/utils.js

@@ -81,15 +81,17 @@ exports.getSymbolFromTokenAddress = getSymbolFromTokenAddress;
  * @param tokenAddr the address of the erc20 token
  * @param spender the address of the spender
  * @param amount the amount to increase the allowance by
- * @param signer an ethers signer
+ * @param signerOrProvider an ethers signer or provider
  * @returns the populated TransactionRequest object
  */
-function increaseAllowance(tokenAddr, spender, amount, signer) {
+function increaseAllowance(tokenAddr, spender, amount, signerOrProvider) {
     return __awaiter(this, void 0, void 0, function* () {
         const abi = [
             'function increaseAllowance(address spender, uint256 value) external returns (bool)',
         ];
-        const contract = new ethers_1.Contract(tokenAddr, abi, signer);
+        // TODO, not all ERC-20 contracts support increaseAllowance
+        // Add a check for that here
+        const contract = new ethers_1.Contract(tokenAddr, abi, signerOrProvider);
         return yield contract.populateTransaction.increaseAllowance(spender, amount);
     });
 }

package/dist/esm/mento.d.ts

@@ -1,5 +1,5 @@
 import { IBroker } from '@mento-protocol/mento-core-ts';
-import { BigNumber, providers, Signer } from 'ethers';
+import { BigNumber, BigNumberish, providers, Signer } from 'ethers';
 import { Address } from './types';
 export interface Exchange {
     providerAddr: Address;
@@ -56,7 +56,7 @@ export declare class Mento {
      * @param amountOut the amount of tokenOut to be bought
      * @returns the amount of tokenIn to be sold
      */
-    getAmountIn(tokenIn: Address, tokenOut: Address, amountOut: BigNumber): Promise<BigNumber>;
+    getAmountIn(tokenIn: Address, tokenOut: Address, amountOut: BigNumberish): Promise<BigNumber>;
     /**
      * Returns the amount of tokenOut to be bought by selling amountIn of tokenIn
      * @param tokenIn the token to be sold
@@ -64,14 +64,14 @@ export declare class Mento {
      * @param amountIn the amount of tokenIn to be sold
      * @returns the amount of tokenOut to be bought
      */
-    getAmountOut(tokenIn: Address, tokenOut: Address, amountIn: BigNumber): Promise<BigNumber>;
+    getAmountOut(tokenIn: Address, tokenOut: Address, amountIn: BigNumberish): Promise<BigNumber>;
     /**
      * Increases the broker's trading allowance for the given token
      * @param token the token to increase the allowance for
      * @param amount the amount to increase the allowance by
      * @returns the populated TransactionRequest object
      */
-    increaseTradingAllowance(token: Address, amount: BigNumber): Promise<providers.TransactionRequest>;
+    increaseTradingAllowance(token: Address, amount: BigNumberish): Promise<providers.TransactionRequest>;
     /**
      * Returns a token swap populated tx object with a fixed amount of tokenIn and a minimum amount of tokenOut
      * Submitting the transaction to execute the swap is left to the consumer
@@ -81,7 +81,7 @@ export declare class Mento {
      * @param amountOutMin the minimum amount of tokenOut to be bought
      * @returns the populated TransactionRequest object
      */
-    swapIn(tokenIn: Address, tokenOut: Address, amountIn: BigNumber, amountOutMin: BigNumber): Promise<providers.TransactionRequest>;
+    swapIn(tokenIn: Address, tokenOut: Address, amountIn: BigNumberish, amountOutMin: BigNumberish): Promise<providers.TransactionRequest>;
     /**
      * Returns a token swap populated tx object with a maximum amount of tokenIn and a fixed amount of tokenOut
      * Submitting the transaction to execute the swap is left to the consumer
@@ -91,7 +91,7 @@ export declare class Mento {
      * @param amountInMax the maximum amount of tokenIn to be sold
      * @returns the populated TransactionRequest object
      */
-    swapOut(tokenIn: Address, tokenOut: Address, amountOut: BigNumber, amountInMax: BigNumber): Promise<providers.TransactionRequest>;
+    swapOut(tokenIn: Address, tokenOut: Address, amountOut: BigNumberish, amountInMax: BigNumberish): Promise<providers.TransactionRequest>;
     /**
      * Returns the mento instance's broker contract
      * @returns broker contract

package/dist/esm/mento.js

@@ -114,13 +114,15 @@ export class Mento {
      */
     increaseTradingAllowance(token, amount) {
         return __awaiter(this, void 0, void 0, function* () {
-            if (!Signer.isSigner(this.signerOrProvider)) {
-                throw new Error('A signer is required to populate the increaseAllowance tx object');
-            }
             const spender = this.broker.address;
             const tx = yield increaseAllowance(token, spender, amount, this.signerOrProvider);
-            // The contract call doesn't populate all of the signer fields, so we need an extra call for the signer
-            return this.signerOrProvider.populateTransaction(tx);
+            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
+                return this.signerOrProvider.populateTransaction(tx);
+            }
+            else {
+                return tx;
+            }
         });
     }
     /**
@@ -134,13 +136,15 @@ export class Mento {
      */
     swapIn(tokenIn, tokenOut, amountIn, amountOutMin) {
         return __awaiter(this, void 0, void 0, function* () {
-            if (!Signer.isSigner(this.signerOrProvider)) {
-                throw new Error('A signer is required to populate the swapIn tx object');
-            }
             const exchange = yield this.getExchangeForTokens(tokenIn, tokenOut);
             const tx = yield this.broker.populateTransaction.swapIn(exchange.providerAddr, exchange.id, tokenIn, tokenOut, amountIn, amountOutMin);
-            // The broker's call doesn't populate all of the signer fields, so we need an extra call for the signer
-            return this.signerOrProvider.populateTransaction(tx);
+            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
+                return this.signerOrProvider.populateTransaction(tx);
+            }
+            else {
+                return tx;
+            }
         });
     }
     /**
@@ -154,13 +158,15 @@ export class Mento {
      */
     swapOut(tokenIn, tokenOut, amountOut, amountInMax) {
         return __awaiter(this, void 0, void 0, function* () {
-            if (!Signer.isSigner(this.signerOrProvider)) {
-                throw new Error('A signer is required to populate the swapOut tx object');
-            }
             const exchange = yield this.getExchangeForTokens(tokenIn, tokenOut);
             const tx = yield this.broker.populateTransaction.swapOut(exchange.providerAddr, exchange.id, tokenIn, tokenOut, amountOut, amountInMax);
-            // The broker's call doesn't populate all of the signer fields, so we need an extra call for the signer
-            return this.signerOrProvider.populateTransaction(tx);
+            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
+                return this.signerOrProvider.populateTransaction(tx);
+            }
+            else {
+                return tx;
+            }
         });
     }
     /**

package/dist/esm/utils.d.ts

@@ -1,4 +1,4 @@
-import { BigNumber, providers, Signer } from 'ethers';
+import { BigNumberish, providers, Signer } from 'ethers';
 import { Address } from './types';
 /**
  * Ensures that given signer is truly a a connected signer
@@ -30,7 +30,7 @@ export declare function getSymbolFromTokenAddress(tokenAddr: Address, signerOrPr
  * @param tokenAddr the address of the erc20 token
  * @param spender the address of the spender
  * @param amount the amount to increase the allowance by
- * @param signer an ethers signer
+ * @param signerOrProvider an ethers signer or provider
  * @returns the populated TransactionRequest object
  */
-export declare function increaseAllowance(tokenAddr: string, spender: string, amount: BigNumber, signer: Signer): Promise<providers.TransactionRequest>;
+export declare function increaseAllowance(tokenAddr: string, spender: string, amount: BigNumberish, signerOrProvider: Signer | providers.Provider): Promise<providers.TransactionRequest>;

package/dist/esm/utils.js

@@ -74,15 +74,17 @@ export function getSymbolFromTokenAddress(tokenAddr, signerOrProvider) {
  * @param tokenAddr the address of the erc20 token
  * @param spender the address of the spender
  * @param amount the amount to increase the allowance by
- * @param signer an ethers signer
+ * @param signerOrProvider an ethers signer or provider
  * @returns the populated TransactionRequest object
  */
-export function increaseAllowance(tokenAddr, spender, amount, signer) {
+export function increaseAllowance(tokenAddr, spender, amount, signerOrProvider) {
     return __awaiter(this, void 0, void 0, function* () {
         const abi = [
             'function increaseAllowance(address spender, uint256 value) external returns (bool)',
         ];
-        const contract = new Contract(tokenAddr, abi, signer);
+        // TODO, not all ERC-20 contracts support increaseAllowance
+        // Add a check for that here
+        const contract = new Contract(tokenAddr, abi, signerOrProvider);
         return yield contract.populateTransaction.increaseAllowance(spender, amount);
     });
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@mento-protocol/mento-sdk",
   "description": "Official SDK for interacting with the Mento Protocol",
-  "version": "0.1.3",
+  "version": "0.1.4",
   "license": "MIT",
   "author": "Mento Labs",
   "keywords": [
@@ -80,7 +80,7 @@
     "@mento-protocol/mento-core-ts": "^0.1.0"
   },
   "peerDependencies": {
-    "ethers": "^5.7.2"
+    "ethers": "^5.7"
   },
   "packageManager": "yarn@3.3.1"
 }