@curvefi/api 1.6.1 → 1.9.0

package/README.md

@@ -1,13 +1,223 @@
 # Curve JS
 
+## Setup
+
+Install from npm:
+
+`npm install @curvefi/api`
+
+## Init
+```ts
+import curve from "@curvefi/api";
+
+(async () => {
+    // 1. Dev
+    await curve.init('JsonRpc', {url: 'http://localhost:8545/', privateKey: ''}, { gasPrice: 0, maxFeePerGas: 0, maxPriorityFeePerGas: 0, chainId: 1 });
+    // OR
+    await curve.init('JsonRpc', {}, { chainId: 1 }); // In this case fee data will be specified automatically
+
+    // 2. Infura
+    curve.init("Infura", { network: "homestead", apiKey: <INFURA_KEY> }, { chainId: 1 });
+    
+    // 3. Web3 provider
+    curve.init('Web3', { externalProvider: <WEB3_PROVIDER> }, { chainId: 1 });
+})()
+```
+**Note 1.** ```chainId``` parameter is optional, but you must specify it in the case you use Metamask on localhost network, because Metamask has that [bug](https://hardhat.org/metamask-issue.html)
+
+**Note 2.** Web3 init requires the address. Therefore, it can be initialized only after receiving the address.
+
+**Wrong ❌️**
+```tsx
+import type { FunctionComponent } from 'react'
+import { useState, useMemo } from 'react'
+import { providers } from 'ethers'
+import Onboard from 'bnc-onboard'
+import type { Wallet } from 'bnc-onboard/dist/src/interfaces'
+import curve from '@curvefi/api'
+
+    ...
+
+const WalletProvider: FunctionComponent = ({ children }) => {
+    const [wallet, setWallet] = useState<Wallet>()
+    const [provider, setProvider] = useState<providers.Web3Provider>()
+    const [address, setAddress] = useState<string>()
+
+    const networkId = 1
+
+    const onboard = useMemo(
+        () =>
+            Onboard({
+                dappId: DAPP_ID,
+                networkId,
+
+                subscriptions: {
+                    address: (address) => {
+                        setAddress(address)
+                    },
+
+                    wallet: (wallet) => {
+                        setWallet(wallet)
+                        if (wallet.provider) {
+                            curve.init("Web3", { externalProvider: wallet.provider }, { chainId: networkId })
+                        }
+                    },
+                },
+                walletSelect: {
+                    wallets: wallets,
+                },
+            }),
+        []
+    )
+
+    ...
+```
+
+**Right ✔️**
+```tsx
+import type { FunctionComponent } from 'react'
+import { useState, useMemo, useEffect } from 'react'
+import { providers } from 'ethers'
+import Onboard from 'bnc-onboard'
+import type { Wallet } from 'bnc-onboard/dist/src/interfaces'
+import curve from '@curvefi/api'
+
+    ...
+
+const WalletProvider: FunctionComponent = ({ children }) => {
+    const [wallet, setWallet] = useState<Wallet>()
+    const [provider, setProvider] = useState<providers.Web3Provider>()
+    const [address, setAddress] = useState<string>()
+
+    const networkId = 1
+
+    const onboard = useMemo(
+        () =>
+            Onboard({
+                dappId: DAPP_ID,
+                networkId,
+
+                subscriptions: {
+                    address: (address) => {
+                        setAddress(address)
+                    },
+
+                    wallet: (wallet) => {
+                        setWallet(wallet)
+                    },
+                },
+                walletSelect: {
+                    wallets: wallets,
+                },
+            }),
+        []
+    )
+
+    useEffect(() => {
+        if (address && wallet?.provider) {
+            curve.init("Web3", { externalProvider: wallet.provider }, { chainId: networkId })
+        }
+    }, [address, wallet?.provider]);
+
+    ...
+```
+
+## Balances
+```ts
+import curve from "@curvefi/api";
+
+(async () => {
+    await curve.init('JsonRpc', {}, { gasPrice: 0, maxFeePerGas: 0, maxPriorityFeePerGas: 0, chainId: 1 });
+
+    console.log(await curve.getBalances(['DAI', 'sUSD']));
+    // OR console.log(await curve.getBalances(['0x6B175474E89094C44Da98b954EedeAC495271d0F', '0x57Ab1ec28D129707052df4dF418D58a2D46d5f51']));
+    
+    // [ '10000.0', '10000.0' ]
+
+    console.log(await curve.getBalances(['aDAI', 'aSUSD']));
+    // OR console.log(await curve.getBalances(['0x028171bCA77440897B824Ca71D1c56caC55b68A3', '0x6c5024cd4f8a59110119c56f8933403a539555eb']));
+
+    // [ '10000.000211315200513239', '10000.0' ]
+
+    
+    // --- Pool ---
+
+    const saave = new curve.Pool('saave');
+
+    
+    // 1. Current address balances (signer balances)
+    
+    console.log(await saave.balances());
+    // {
+    //     lpToken: '0.0',
+    //     gauge: '0.0',
+    //     DAI: '10000.0',
+    //     sUSD: '10000.0',
+    //     aDAI: '10000.000211315200513239',
+    //     aSUSD: '10000.0'
+    // }
+
+    console.log(await saave.lpTokenBalances());
+    // { lpToken: '0.0', gauge: '0.0' }
+    
+    console.log(await saave.underlyingCoinBalances());
+    // { DAI: '10000.0', sUSD: '10000.0' }
+
+    console.log(await saave.coinBalances());
+    // { aDAI: '10000.000211315200513239', aSUSD: '10000.0' }
+    
+    console.log(await saave.allCoinBalances());
+    // {
+    //     DAI: '10000.0',
+    //     sUSD: '10000.0',
+    //     aDAI: '10000.000211315200513239',
+    //     aSUSD: '10000.0'
+    // }
+
+    
+    // 2. For every method above you can specify the address
+    
+    console.log(await saave.balances("0x0063046686E46Dc6F15918b61AE2B121458534a5"));
+    // {
+    //     lpToken: '0.0',
+    //     gauge: '0.0',
+    //     DAI: '0.0',
+    //     sUSD: '0.0',
+    //     aDAI: '0.0',
+    //     aSUSD: '0.0'
+    // }
+
+    // Or several addresses
+    console.log(await saave.balances("0x0063046686E46Dc6F15918b61AE2B121458534a5", "0x66aB6D9362d4F35596279692F0251Db635165871"));
+    // {
+    //     '0x0063046686E46Dc6F15918b61AE2B121458534a5': {
+    //         lpToken: '0.0',
+    //         gauge: '0.0',
+    //         DAI: '0.0',
+    //         sUSD: '0.0',
+    //         aDAI: '0.0',
+    //         aSUSD: '0.0'
+    //     },
+    //     '0x66aB6D9362d4F35596279692F0251Db635165871': {
+    //         lpToken: '0.0',
+    //         gauge: '0.0',
+    //         DAI: '10000.0',
+    //         sUSD: '10000.0',
+    //         aDAI: '10000.000211315200513239',
+    //         aSUSD: '10000.0'
+    //     }
+    // }
+
+})()
+```
+
 ## Add/remove liquidity
 
 ```ts
-import curve from "curve";
+import curve from "@curvefi/api";
 
 (async () => {
-    await curve.init('JsonRpc', {url: 'http://localhost:8545/', privateKey: ''}, { gasPrice: 0, chainId: 1 });
-    // OR await curve.init('JsonRpc', {}, { gasPrice: 0, chainId: 1 });
+    await curve.init('JsonRpc', {}, { gasPrice: 0, maxFeePerGas: 0, maxPriorityFeePerGas: 0, chainId: 1 });
 
     const pool = new curve.Pool('aave');
     console.log(pool.underlyingCoins); // [ 'DAI', 'USDC', 'USDT' ]
@@ -208,8 +418,10 @@ import curve from "curve";
 ## Exchange using all pools
 
 ```ts
+import curve from "@curvefi/api";
+
 (async () => {
-    await curve.init('JsonRpc', {}, { gasPrice: 0, chainId: 1 });
+    await curve.init('JsonRpc', {}, { gasPrice: 0, maxFeePerGas: 0, maxPriorityFeePerGas: 0, chainId: 1 });
 
     console.log(await curve.getBalances(['DAI', 'USDC']));
     // [ '1000.0', '0.0' ]
@@ -233,8 +445,10 @@ import curve from "curve";
 ## Cross-Asset Exchange
 
 ```ts
+import curve from "@curvefi/api";
+
 (async () => {
-    await curve.init('JsonRpc', {}, { gasPrice: 0, chainId: 1 });
+    await curve.init('JsonRpc', {}, { gasPrice: 0, maxFeePerGas: 0, maxPriorityFeePerGas: 0, chainId: 1 });
 
     console.log(await curve.getBalances(['DAI', 'WBTC']));
     // [ '1000.0', '0.0' ]
@@ -257,8 +471,10 @@ import curve from "curve";
 
 ## Boosting
 ```ts
-const boostingTest = async () => {
-    await curve.init('JsonRpc', {}, { gasPrice: 0, chainId: 1 });
+import curve from "@curvefi/api";
+
+(async () => {
+    await curve.init('JsonRpc', {}, { gasPrice: 0, maxFeePerGas: 0, maxPriorityFeePerGas: 0, chainId: 1 });
 
     console.log(await curve.boosting.getCrv());
     // 100000.0
@@ -286,5 +502,121 @@ const boostingTest = async () => {
     // { lockedAmount: '1500.0', unlockTime: 1688601600000 }
     // 746.262271689452535192 veCRV
     // 0.000018613852077810 veCRV %
-}
+})()
+```
+
+## Allowance and approve
+### General methods
+```ts
+const spender = "0xbEbc44782C7dB0a1A60Cb6fe97d0b483032FF1C7" // 3pool swap address
+
+await curve.getAllowance(["DAI", "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48"], curve.signerAddress, spender)
+// [ '0.0', '0.0' ]
+await curve.hasAllowance(["DAI", "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48"], ['1000', '1000'], curve.signerAddress, spender)
+// false
+await curve.ensureAllowance(["DAI", "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48"], ['1000', '1000'], spender)
+// [
+//     '0xb0cada2a2983dc0ed85a26916d32b9caefe45fecde47640bd7d0e214ff22aed3',
+//     '0x00ea7d827b3ad50ce933e96c579810cd7e70d66a034a86ec4e1e10005634d041'
+// ]
+
+```
+
+### Pools
+```ts
+const pool = new curve.Pool('usdn');
+
+// --- Add Liquidity ---
+
+await pool.addLiquidityIsApproved(["1000", "1000", "1000", "1000"])
+// false
+await pool.addLiquidityApprove(["1000", "1000", "1000", "1000"])
+// [
+//     '0xbac4b0271ad340488a8135dda2f9adf3e3c402361b514f483ba2b7e9cafbdc21',
+//     '0x39fe196a52d9fb649f9c099fbd40ae773d28c457195c878ecdb7cd05be0f6512',
+//     '0xf39ebfb4b11434b879f951a08a1c633a038425c35eae09b2b7015816d068de3c',
+//     '0xa8b1631384da247efe1987b56fe010b852fc1d38e4d71d204c7dc5448a3a6c96'
+// ]
+
+
+// --- Add Liquidity Wrapped ---
+
+await pool.addLiquidityWrappedIsApproved(["1000", "1000"])
+// false
+await pool.addLiquidityWrappedApprove(["1000", "1000"])
+// [
+//     '0xe486bfba5e9e8190be580ad528707876136e6b0c201e228db0f3bd82e51619fa',
+//     '0xd56f7d583b20f4f7760510cc4310e3651f7dab8c276fe3bcde7e7200d65ed0dd'
+// ]
+
+
+// --- Remove Liquidity ---
+
+await pool.removeLiquidityIsApproved("1000")
+await pool.removeLiquidityApprove("1000")
+
+
+// --- Remove Liquidity Imbalance ---
+
+await pool.removeLiquidityImbalanceIsApproved(["1000", "1000", "1000", "1000"])
+await pool.removeLiquidityImbalanceApprove(["1000", "1000", "1000", "1000"])
+
+
+// --- Remove Liquidity One Coin ---
+
+await pool.removeLiquidityOneCoinIsApproved("1000")
+await pool.removeLiquidityOneCoinApprove("1000")
+
+
+// --- Gauge Deposit ---
+
+await pool.gaugeDepositIsApproved("1000")
+await pool.gaugeDepositApprove("1000")
+
+
+// --- Exchange ---
+
+await pool.exchangeIsApproved("DAI", "1000")
+await pool.exchangeApprove("DAI", "1000")
+
+
+// --- Exchange Wrapped ---
+
+await pool.exchangeWrappedIsApproved("0x6c3F90f043a72FA612cbac8115EE7e52BDe6E490", "1000")
+await pool.exchangeWrappedApprove("0x6c3F90f043a72FA612cbac8115EE7e52BDe6E490", "1000")
+```
+**Note.** Removing wrapped does not require approve.
+
+### Exchange
+```ts
+// Straight
+await curve.exchangeisApproved("DAI", "0x99d8a9c45b2eca8864373a26d1459e3dff1e17f3", "1000"); // DAI -> MIM
+await curve.exchangeApprove("DAI", "0x99d8a9c45b2eca8864373a26d1459e3dff1e17f3", "1000"); // DAI -> MIM
+
+// Cross-Asset
+await curve.crossAssetExchangeIsApproved("DAI", "1000");
+await curve.crossAssetExchangeApprove("DAI", "1000");
+```
+
+### Boosting
+```ts
+await curve.boosting.isApproved('1000')
+await curve.boosting.approve('1000')
+```
+
+## Gas estimation
+Every non-constant method has corresponding gas estimation method. Rule: ```obj.method -> obj.estimateGas.method```
+
+**Examples**
+```ts
+const spender = "0xbEbc44782C7dB0a1A60Cb6fe97d0b483032FF1C7" // 3pool swap address
+await curve.estimateGas.ensureAllowance(["DAI", "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48"], curve.signerAddress, spender);
+
+const pool = new curve.Pool('usdn');
+await pool.estimateGas.addLiquidityApprove(["1000", "1000", "1000", "1000"])
+await pool.estimateGas.addLiquidity(["1000", "1000", "1000", "1000"])
+
+await curve.estimateGas.crossAssetExchange('DAI', "WBTC", "1000", 0.01)
+
+await curve.boosting.estimateGas.createLock('1000', 365)
 ```

package/lib/boosting.d.ts

@@ -9,6 +9,9 @@ export declare const getLockedAmountAndUnlockTime: (...addresses: string[] | str
 }>;
 export declare const getVeCrv: (...addresses: string[] | string[][]) => Promise<DictInterface<string> | string>;
 export declare const getVeCrvPct: (...addresses: string[] | string[][]) => Promise<DictInterface<string> | string>;
+export declare const isApproved: (amount: string) => Promise<boolean>;
+export declare const approveEstimateGas: (amount: string) => Promise<number>;
+export declare const approve: (amount: string) => Promise<string[]>;
 export declare const createLockEstimateGas: (amount: string, days: number) => Promise<number>;
 export declare const createLock: (amount: string, days: number) => Promise<string>;
 export declare const increaseAmountEstimateGas: (amount: string) => Promise<number>;

package/lib/boosting.js

@@ -47,7 +47,7 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
     }
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.withdrawLockedCrv = exports.withdrawLockedCrvEstimateGas = exports.increaseUnlockTime = exports.increaseUnlockTimeEstimateGas = exports.increaseAmount = exports.increaseAmountEstimateGas = exports.createLock = exports.createLockEstimateGas = exports.getVeCrvPct = exports.getVeCrv = exports.getLockedAmountAndUnlockTime = exports.getCrv = void 0;
+exports.withdrawLockedCrv = exports.withdrawLockedCrvEstimateGas = exports.increaseUnlockTime = exports.increaseUnlockTimeEstimateGas = exports.increaseAmount = exports.increaseAmountEstimateGas = exports.createLock = exports.createLockEstimateGas = exports.approve = exports.approveEstimateGas = exports.isApproved = exports.getVeCrvPct = exports.getVeCrv = exports.getLockedAmountAndUnlockTime = exports.getCrv = void 0;
 var ethers_1 = require("ethers");
 var utils_1 = require("./utils");
 var utils_2 = require("./utils");
@@ -164,6 +164,33 @@ var getVeCrvPct = function () {
     });
 };
 exports.getVeCrvPct = getVeCrvPct;
+var isApproved = function (amount) { return __awaiter(void 0, void 0, void 0, function () {
+    return __generator(this, function (_a) {
+        switch (_a.label) {
+            case 0: return [4 /*yield*/, (0, utils_1.hasAllowance)([curve_1.ALIASES.crv], [amount], curve_1.curve.signerAddress, curve_1.ALIASES.voting_escrow)];
+            case 1: return [2 /*return*/, _a.sent()];
+        }
+    });
+}); };
+exports.isApproved = isApproved;
+var approveEstimateGas = function (amount) { return __awaiter(void 0, void 0, void 0, function () {
+    return __generator(this, function (_a) {
+        switch (_a.label) {
+            case 0: return [4 /*yield*/, (0, utils_1.ensureAllowanceEstimateGas)([curve_1.ALIASES.crv], [amount], curve_1.ALIASES.voting_escrow)];
+            case 1: return [2 /*return*/, _a.sent()];
+        }
+    });
+}); };
+exports.approveEstimateGas = approveEstimateGas;
+var approve = function (amount) { return __awaiter(void 0, void 0, void 0, function () {
+    return __generator(this, function (_a) {
+        switch (_a.label) {
+            case 0: return [4 /*yield*/, (0, utils_1.ensureAllowance)([curve_1.ALIASES.crv], [amount], curve_1.ALIASES.voting_escrow)];
+            case 1: return [2 /*return*/, _a.sent()];
+        }
+    });
+}); };
+exports.approve = approve;
 var createLockEstimateGas = function (amount, days) { return __awaiter(void 0, void 0, void 0, function () {
     var crvBalance, _amount, unlockTime;
     return __generator(this, function (_a) {
@@ -172,7 +199,7 @@ var createLockEstimateGas = function (amount, days) { return __awaiter(void 0, v
             case 1:
                 crvBalance = _a.sent();
                 if (Number(crvBalance) < Number(amount)) {
-                    throw Error("Not enough . Actual: " + crvBalance + ", required: " + amount);
+                    throw Error("Not enough . Actual: ".concat(crvBalance, ", required: ").concat(amount));
                 }
                 return [4 /*yield*/, (0, utils_1.hasAllowance)([curve_1.ALIASES.crv], [amount], curve_1.curve.signerAddress, curve_1.ALIASES.voting_escrow)];
             case 2:
@@ -218,7 +245,7 @@ var increaseAmountEstimateGas = function (amount) { return __awaiter(void 0, voi
             case 1:
                 crvBalance = _a.sent();
                 if (Number(crvBalance) < Number(amount)) {
-                    throw Error("Not enough. Actual: " + crvBalance + ", required: " + amount);
+                    throw Error("Not enough. Actual: ".concat(crvBalance, ", required: ").concat(amount));
                 }
                 return [4 /*yield*/, (0, utils_1.hasAllowance)([curve_1.ALIASES.crv], [amount], curve_1.curve.signerAddress, curve_1.ALIASES.voting_escrow)];
             case 2:

package/lib/constants/abis/abis-ethereum.js

@@ -1414,12 +1414,12 @@ exports.poolsData = {
         swap_address: '0xD51a44d3FaE010294C616388b506AcdA1bfAAE46',
         token_address: '0xc4AD29ba4B3c580e6D59105FFf484999997675Ff',
         gauge_address: '0xDeFd8FdD20e0f34115C7018CCfb655796F6B2168',
-        underlying_coins: ['USDT', 'WBTC', 'WETH'],
+        underlying_coins: ['USDT', 'WBTC', 'ETH'],
         coins: ['USDT', 'WBTC', 'WETH'],
         underlying_coin_addresses: [
             '0xdAC17F958D2ee523a2206206994597C13D831ec7',
             '0x2260FAC5E5542a773Aa44fBCfeDf7C193bc2C599',
-            '0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2',
+            '0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE',
         ],
         coin_addresses: [
             '0xdAC17F958D2ee523a2206206994597C13D831ec7',

package/lib/constants/abis/json/registry_exchange.json

@@ -155,43 +155,6 @@
             }
         ]
     },
-    {
-        "stateMutability": "payable",
-        "type": "function",
-        "name": "exchange",
-        "inputs": [
-            {
-                "name": "_pool",
-                "type": "address"
-            },
-            {
-                "name": "_from",
-                "type": "address"
-            },
-            {
-                "name": "_to",
-                "type": "address"
-            },
-            {
-                "name": "_amount",
-                "type": "uint256"
-            },
-            {
-                "name": "_expected",
-                "type": "uint256"
-            },
-            {
-                "name": "_receiver",
-                "type": "address"
-            }
-        ],
-        "outputs": [
-            {
-                "name": "",
-                "type": "uint256"
-            }
-        ]
-    },
     {
         "stateMutability": "view",
         "type": "function",

package/lib/constants/abis/json/tricrypto2/deposit.json

@@ -35,52 +35,6 @@
             }
         ]
     },
-    {
-        "stateMutability": "payable",
-        "type": "function",
-        "name": "add_liquidity",
-        "inputs": [
-            {
-                "name": "_amounts",
-                "type": "uint256[3]"
-            },
-            {
-                "name": "_min_mint_amount",
-                "type": "uint256"
-            },
-            {
-                "name": "_receiver",
-                "type": "address"
-            }
-        ],
-        "outputs": [
-            {
-                "name": "",
-                "type": "uint256"
-            }
-        ]
-    },
-    {
-        "stateMutability": "nonpayable",
-        "type": "function",
-        "name": "remove_liquidity",
-        "inputs": [
-            {
-                "name": "_amount",
-                "type": "uint256"
-            },
-            {
-                "name": "_min_amounts",
-                "type": "uint256[3]"
-            }
-        ],
-        "outputs": [
-            {
-                "name": "",
-                "type": "uint256[3]"
-            }
-        ]
-    },
     {
         "stateMutability": "nonpayable",
         "type": "function",
@@ -93,10 +47,6 @@
             {
                 "name": "_min_amounts",
                 "type": "uint256[3]"
-            },
-            {
-                "name": "_receiver",
-                "type": "address"
             }
         ],
         "outputs": [
@@ -131,35 +81,6 @@
             }
         ]
     },
-    {
-        "stateMutability": "nonpayable",
-        "type": "function",
-        "name": "remove_liquidity_one_coin",
-        "inputs": [
-            {
-                "name": "_token_amount",
-                "type": "uint256"
-            },
-            {
-                "name": "i",
-                "type": "uint256"
-            },
-            {
-                "name": "_min_amount",
-                "type": "uint256"
-            },
-            {
-                "name": "_receiver",
-                "type": "address"
-            }
-        ],
-        "outputs": [
-            {
-                "name": "",
-                "type": "uint256"
-            }
-        ]
-    },
     {
         "stateMutability": "view",
         "type": "function",

package/lib/curve.d.ts

@@ -11,6 +11,7 @@ export declare const ALIASES: {
     fee_distributor: string;
     address_provider: string;
     router: string;
+    registry_exchange: string;
 };
 declare class Curve {
     provider: ethers.providers.Web3Provider | ethers.providers.JsonRpcProvider;