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

package/dist/cjs/utils.d.ts

@@ -1,50 +0,0 @@
-import { BigNumberish, providers, Signer } from 'ethers';
-import { Address } from './interfaces';
-import { TradablePair } from './mento';
-/**
- * Gets the chain ID from a signer or provider
- * @param signerOrProvider an ethers provider or signer
- * @returns the chain ID
- */
-export declare function getChainId(signerOrProvider: Signer | providers.Provider): Promise<number>;
-/**
- * Ensures that given signer is truly a a connected signer
- * @param signer an ethers signer
- * @throws if signer is invalid or not connected
- */
-export declare function validateSigner(signer: Signer): void;
-/**
- * Ensures that given signerOrProvider is truly a provider or a connected signer
- * @param signerOrProvider an ethers provider or signer
- * @throws if signerOrProvider is invalid or not connected
- */
-export declare function validateSignerOrProvider(signerOrProvider: Signer | providers.Provider): void;
-/**
- * Returns the broker address from the Celo registry
- * @param signerOrProvider an ethers provider or signer
- * @returns the broker address
- */
-export declare function getBrokerAddressFromRegistry(signerOrProvider: Signer | providers.Provider): Promise<Address>;
-/**
- * Returns the symbol of an erc20 token
- * @param tokenAddr the address of the erc20 token
- * @param signerOrProvider an ethers provider or signer
- * @returns the symbol of the erc20 token
- */
-export declare function getSymbolFromTokenAddress(tokenAddr: Address, signerOrProvider: Signer | providers.Provider): Promise<string>;
-/**
- * Returns a populated tx obj for increasing the allowance of a spender for a given erc20 token by a given amount
- * @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 signerOrProvider an ethers signer or provider
- * @returns the populated TransactionRequest object
- */
-export declare function increaseAllowance(tokenAddr: string, spender: string, amount: BigNumberish, signerOrProvider: Signer | providers.Provider): Promise<providers.TransactionRequest>;
-/**
- * Find a token address by its symbol from tradable pairs
- * @param pairs array of tradable pairs to search through
- * @param symbol the token symbol to find (case-insensitive)
- * @returns the token address if found, null otherwise
- */
-export declare function findTokenBySymbol(pairs: readonly TradablePair[], symbol: string): string | null;

package/dist/cjs/utils.js

@@ -1,129 +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.findTokenBySymbol = exports.increaseAllowance = exports.getSymbolFromTokenAddress = exports.getBrokerAddressFromRegistry = exports.validateSignerOrProvider = exports.validateSigner = exports.getChainId = void 0;
-const ethers_1 = require("ethers");
-/**
- * Gets the chain ID from a signer or provider
- * @param signerOrProvider an ethers provider or signer
- * @returns the chain ID
- */
-function getChainId(signerOrProvider) {
-    return __awaiter(this, void 0, void 0, function* () {
-        const provider = ethers_1.Signer.isSigner(signerOrProvider)
-            ? signerOrProvider.provider
-            : signerOrProvider;
-        return (yield provider.getNetwork()).chainId;
-    });
-}
-exports.getChainId = getChainId;
-/**
- * Ensures that given signer is truly a a connected signer
- * @param signer an ethers signer
- * @throws if signer is invalid or not connected
- */
-function validateSigner(signer) {
-    if (!ethers_1.Signer.isSigner(signer)) {
-        throw new Error('A valid signer must be provided');
-    }
-    if (!ethers_1.providers.Provider.isProvider(signer.provider)) {
-        throw new Error('Signer must be connected to a provider');
-    }
-}
-exports.validateSigner = validateSigner;
-/**
- * Ensures that given signerOrProvider is truly a provider or a connected signer
- * @param signerOrProvider an ethers provider or signer
- * @throws if signerOrProvider is invalid or not connected
- */
-function validateSignerOrProvider(signerOrProvider) {
-    const isSigner = ethers_1.Signer.isSigner(signerOrProvider);
-    const isProvider = ethers_1.providers.Provider.isProvider(signerOrProvider);
-    if (!isSigner && !isProvider) {
-        throw new Error('A valid signer or provider must be provided');
-    }
-    if (isSigner && !ethers_1.providers.Provider.isProvider(signerOrProvider.provider)) {
-        throw new Error('Signer must be connected to a provider');
-    }
-}
-exports.validateSignerOrProvider = validateSignerOrProvider;
-/**
- * Returns the broker address from the Celo registry
- * @param signerOrProvider an ethers provider or signer
- * @returns the broker address
- */
-function getBrokerAddressFromRegistry(signerOrProvider) {
-    return __awaiter(this, void 0, void 0, function* () {
-        const celoRegistryAddress = '0x000000000000000000000000000000000000ce10';
-        const brokerIdentifier = 'Broker';
-        const registryAbi = [
-            'function getAddressForString(string calldata identifier) external view returns (address)',
-        ];
-        const contract = new ethers_1.Contract(celoRegistryAddress, registryAbi, signerOrProvider);
-        const brokerAddress = yield contract.getAddressForString(brokerIdentifier);
-        if (brokerAddress === ethers_1.constants.AddressZero) {
-            throw Error('Broker address not found in the registry');
-        }
-        return brokerAddress;
-    });
-}
-exports.getBrokerAddressFromRegistry = getBrokerAddressFromRegistry;
-/**
- * Returns the symbol of an erc20 token
- * @param tokenAddr the address of the erc20 token
- * @param signerOrProvider an ethers provider or signer
- * @returns the symbol of the erc20 token
- */
-function getSymbolFromTokenAddress(tokenAddr, signerOrProvider) {
-    return __awaiter(this, void 0, void 0, function* () {
-        const erc20Abi = ['function symbol() external view returns (string memory)'];
-        const contract = new ethers_1.Contract(tokenAddr, erc20Abi, signerOrProvider);
-        return contract.symbol();
-    });
-}
-exports.getSymbolFromTokenAddress = getSymbolFromTokenAddress;
-/**
- * Returns a populated tx obj for increasing the allowance of a spender for a given erc20 token by a given amount
- * @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 signerOrProvider an ethers signer or provider
- * @returns the populated TransactionRequest object
- */
-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)',
-        ];
-        // 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);
-    });
-}
-exports.increaseAllowance = increaseAllowance;
-/**
- * Find a token address by its symbol from tradable pairs
- * @param pairs array of tradable pairs to search through
- * @param symbol the token symbol to find (case-insensitive)
- * @returns the token address if found, null otherwise
- */
-function findTokenBySymbol(pairs, symbol) {
-    for (const pair of pairs) {
-        for (const asset of pair.assets) {
-            if (asset.symbol.toLowerCase() === symbol.toLowerCase()) {
-                return asset.address;
-            }
-        }
-    }
-    return null;
-}
-exports.findTokenBySymbol = findTokenBySymbol;

package/dist/esm/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/esm/ChainClient.js

@@ -1,54 +0,0 @@
-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());
-    });
-};
-import { Signer, providers } from 'ethers';
-import { validateSignerOrProvider } from './utils';
-export class ChainClient {
-    constructor(signerOrProvider) {
-        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 (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 (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 (Signer.isSigner(this.signerOrProvider)) {
-                return this.signerOrProvider.populateTransaction(tx);
-            }
-            else {
-                return tx;
-            }
-        });
-    }
-}

package/dist/esm/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/esm/TestChainClient.js

@@ -1,37 +0,0 @@
-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());
-    });
-};
-export 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;
-        });
-    }
-}

package/dist/esm/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/esm/constants/index.d.ts

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

package/dist/esm/constants/index.js

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

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

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