@curvefi/api 2.68.12 → 2.68.13

package/README.md

@@ -1919,8 +1919,24 @@ import curve from "@curvefi/api";
         "0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2", // WETH
     ];
 
-    // Deploy pool
-    
+    // Get only UI-available implementations
+    const implementations = curve.twocryptoFactory.getImplementations(true);
+    // [
+    //     {
+    //         index: 0,
+    //         address: '0x934791f7F391727db92BFF94cd789c4623d14c52',
+    //         description: '',
+    //         availableInUI: true
+    //     },
+    //     {
+    //         index: '110205523814837221872401067839670671012439480455633721548677383351514213591649',
+    //         address: '0xD1FAeCA80d6FDd1DF4CBcCe4b2551b6Ee63Ae3D6',
+    //         description: 'TwoCrypto (50% DAO fee) — for FX / regular pairs (where donations may stream from within Curve protocol)',
+    //         availableInUI: true
+    //     }
+    // ]
+
+    // Deploy pool with default implementation (implementations[0].index === 0)
     const deployPoolTx = await curve.twocryptoFactory.deployPool(
         "Test crypto pool",
         "TCP",
@@ -1935,6 +1951,23 @@ import curve from "@curvefi/api";
         600,
         1500
     );
+    
+    // OR deploy with FX implementation with 50% DAO fee (implementations[1])
+    // const deployPoolTx = await curve.twocryptoFactory.deployPool(
+    //     "Test crypto pool",
+    //     "TCP",
+    //     coins,
+    //     400000,
+    //     0.0000725,
+    //     0.25,
+    //     0.45,
+    //     0.000002,
+    //     0.00023,
+    //     0.000146,
+    //     600,
+    //     1500,
+    //     implementations[1].index
+    // );
     // {
     //     hash: '0x406900448e537f2fd5c833a4f62a81305b9567e71f870772e10c72271bd78c37',
     //     type: 0,

package/lib/constants/twoCryptoImplementations.d.ts

@@ -0,0 +1,25 @@
+/**
+ * TwoCrypto pool implementation configurations https://docs.curve.finance/deployments/implementations/#cryptoswap-ng
+ */
+export type TwoCryptoImplementationIndex = number | string;
+/**
+ * TwoCrypto implementation indices
+ */
+export declare enum TwoCryptoImplementation {
+    DEFAULT = 0,
+    YB_POOLS_0_PERCENT = "110827960954786879070795645317684308345156454977361180728234664032152099907574",
+    FX_25_PERCENT = "13710427451595223911029771732871636196811780523916976014878790826087297352222",
+    FX_REGULAR_50_PERCENT = "110205523814837221872401067839670671012439480455633721548677383351514213591649",
+    SETTABLE_ADMIN_FEE = "6789"
+}
+/**
+ * Implementation metadata
+ */
+export interface TwoCryptoImplementationInfo {
+    index: TwoCryptoImplementationIndex;
+    address: string;
+    description: string;
+    availableInUI: boolean;
+}
+export declare const TWOCRYPTO_IMPLEMENTATIONS: TwoCryptoImplementationInfo[];
+export declare function getTwoCryptoImplementations(uiOnly?: boolean): TwoCryptoImplementationInfo[];

package/lib/constants/twoCryptoImplementations.js

@@ -0,0 +1,49 @@
+/**
+ * TwoCrypto pool implementation configurations https://docs.curve.finance/deployments/implementations/#cryptoswap-ng
+ */
+/**
+ * TwoCrypto implementation indices
+ */
+export var TwoCryptoImplementation;
+(function (TwoCryptoImplementation) {
+    TwoCryptoImplementation[TwoCryptoImplementation["DEFAULT"] = 0] = "DEFAULT";
+    TwoCryptoImplementation["YB_POOLS_0_PERCENT"] = "110827960954786879070795645317684308345156454977361180728234664032152099907574";
+    TwoCryptoImplementation["FX_25_PERCENT"] = "13710427451595223911029771732871636196811780523916976014878790826087297352222";
+    TwoCryptoImplementation["FX_REGULAR_50_PERCENT"] = "110205523814837221872401067839670671012439480455633721548677383351514213591649";
+    TwoCryptoImplementation["SETTABLE_ADMIN_FEE"] = "6789";
+})(TwoCryptoImplementation || (TwoCryptoImplementation = {}));
+export const TWOCRYPTO_IMPLEMENTATIONS = [
+    {
+        index: TwoCryptoImplementation.DEFAULT,
+        address: "0x934791f7F391727db92BFF94cd789c4623d14c52",
+        description: "",
+        availableInUI: true,
+    },
+    {
+        index: TwoCryptoImplementation.YB_POOLS_0_PERCENT,
+        address: "0x82c251317ede0514302EEE1aD48f838a7A6EcE2F",
+        description: "TwoCrypto (0% DAO fee) — for yb pools",
+        availableInUI: false,
+    },
+    {
+        index: TwoCryptoImplementation.FX_25_PERCENT,
+        address: "0x3B0df55A2c64Ac7A3ada784eEA0898F0FD3cF17e",
+        description: "TwoCrypto (25% DAO fee) — for FX where the asset issuer will be the main source of LP and donations",
+        availableInUI: false,
+    },
+    {
+        index: TwoCryptoImplementation.FX_REGULAR_50_PERCENT,
+        address: "0xD1FAeCA80d6FDd1DF4CBcCe4b2551b6Ee63Ae3D6",
+        description: "TwoCrypto (50% DAO fee) — for FX / regular pairs (where donations may stream from within Curve protocol)",
+        availableInUI: true,
+    },
+    {
+        index: TwoCryptoImplementation.SETTABLE_ADMIN_FEE,
+        address: "0xeC1045809e383811Cc74B3D25219e1607A5f32dC",
+        description: "Alternative implementation with settable admin fee for two/tricrypto (default admin fee remains at 50%)",
+        availableInUI: false,
+    },
+];
+export function getTwoCryptoImplementations(uiOnly = false) {
+    return uiOnly ? TWOCRYPTO_IMPLEMENTATIONS.filter((impl) => impl.availableInUI) : TWOCRYPTO_IMPLEMENTATIONS;
+}

package/lib/factory/deploy.d.ts

@@ -1,5 +1,6 @@
 import { ethers } from "ethers";
 import { Curve } from "../curve.js";
+import { TwoCryptoImplementation } from "../constants/twoCryptoImplementations.js";
 export declare function deployStablePlainPoolEstimateGas(this: Curve, name: string, symbol: string, coins: string[], A: number | string, fee: number | string, // %
 assetType: 0 | 1 | 2 | 3, // 0 = USD, 1 = ETH, 2 = BTC, 3 = Other
 implementationIdx: 0 | 1 | 2 | 3 | 4 | 5, emaTime?: number, // seconds
@@ -45,11 +46,11 @@ export declare function getDeployedCryptoPoolAddress(this: Curve, tx: ethers.Con
 export declare function deployTwocryptoPoolEstimateGas(this: Curve, name: string, symbol: string, coins: string[], A: number | string, gamma: number | string, midFee: number | string, // %
 outFee: number | string, // %
 allowedExtraProfit: number | string, feeGamma: number | string, adjustmentStep: number | string, maHalfTime: number, // Seconds
-initialPrice: number | string): Promise<number>;
+initialPrice: number | string, implementationIdx?: TwoCryptoImplementation): Promise<number>;
 export declare function deployTwocryptoPool(this: Curve, name: string, symbol: string, coins: string[], A: number | string, gamma: number | string, midFee: number | string, // %
 outFee: number | string, // %
 allowedExtraProfit: number | string, feeGamma: number | string, adjustmentStep: number | string, maHalfTime: number, // Seconds
-initialPrice: number | string): Promise<ethers.ContractTransactionResponse>;
+initialPrice: number | string, implementationIdx?: TwoCryptoImplementation): Promise<ethers.ContractTransactionResponse>;
 export declare function getDeployedTwocryptoPoolAddress(this: Curve, tx: ethers.ContractTransactionResponse): Promise<string>;
 export declare function deployTricryptoPoolEstimateGas(this: Curve, name: string, symbol: string, coins: string[], A: number | string, gamma: number | string, midFee: number | string, // %
 outFee: number | string, // %

package/lib/factory/deploy.js

@@ -13,6 +13,7 @@ import { getPool } from "../pools/index.js";
 import { BN, DIGas, getPoolIdBySwapAddress, mulBy1_3, parseUnits, smartNumber } from '../utils.js';
 import CurveLpTokenV5ABI from "../constants/abis/curve_lp_token_v5.json" with { type: "json" };
 import Plain2ETHOracleABIABI from "../constants/abis/factory-v2/Plain2ETHOracle.json" with { type: "json" };
+import { TwoCryptoImplementation } from "../constants/twoCryptoImplementations.js";
 // ------- STABLE PLAIN POOLS -------
 function _deployStablePlainPool(name, symbol, coins, A, fee, // %
 assetType, // 0 = USD, 1 = ETH, 2 = BTC, 3 = Other
@@ -389,7 +390,7 @@ export function getDeployedCryptoPoolAddress(tx) {
 function _deployTwocryptoPool(name, symbol, coins, A, gamma, midFee, // %
 outFee, // %
 allowedExtraProfit, feeGamma, adjustmentStep, maHalfTime, // Seconds
-initialPrice, estimateGas) {
+initialPrice, implementationIdx, estimateGas) {
     return __awaiter(this, void 0, void 0, function* () {
         if (name.length > 32)
             throw Error("Max name length = 32");
@@ -447,28 +448,28 @@ initialPrice, estimateGas) {
         const _maHalfTime = parseUnits(maHalfTime, 0);
         const _initialPrice = parseUnits(initialPrice);
         const contract = this.contracts[this.constants.ALIASES.twocrypto_factory].contract;
-        const gas = yield contract.deploy_pool.estimateGas(name, symbol, coins, 0, _A, _gamma, _midFee, _outFee, _feeGamma, _allowedExtraProfit, _adjustmentStep, _maHalfTime, _initialPrice, this.constantOptions);
+        const gas = yield contract.deploy_pool.estimateGas(name, symbol, coins, implementationIdx, _A, _gamma, _midFee, _outFee, _feeGamma, _allowedExtraProfit, _adjustmentStep, _maHalfTime, _initialPrice, this.constantOptions);
         if (estimateGas)
             return smartNumber(gas);
         const gasLimit = mulBy1_3(DIGas(gas));
         yield this.updateFeeData();
-        return yield contract.deploy_pool(name, symbol, coins, 0, _A, _gamma, _midFee, _outFee, _feeGamma, _allowedExtraProfit, _adjustmentStep, _maHalfTime, _initialPrice, Object.assign(Object.assign({}, this.options), { gasLimit }));
+        return yield contract.deploy_pool(name, symbol, coins, implementationIdx, _A, _gamma, _midFee, _outFee, _feeGamma, _allowedExtraProfit, _adjustmentStep, _maHalfTime, _initialPrice, Object.assign(Object.assign({}, this.options), { gasLimit }));
     });
 }
-export function deployTwocryptoPoolEstimateGas(name, symbol, coins, A, gamma, midFee, // %
-outFee, // %
-allowedExtraProfit, feeGamma, adjustmentStep, maHalfTime, // Seconds
-initialPrice) {
-    return __awaiter(this, void 0, void 0, function* () {
-        return yield _deployTwocryptoPool.call(this, name, symbol, coins, A, gamma, midFee, outFee, allowedExtraProfit, feeGamma, adjustmentStep, maHalfTime, initialPrice, true);
+export function deployTwocryptoPoolEstimateGas(name_1, symbol_1, coins_1, A_1, gamma_1, midFee_1, outFee_1, allowedExtraProfit_1, feeGamma_1, adjustmentStep_1, maHalfTime_1, initialPrice_1) {
+    return __awaiter(this, arguments, void 0, function* (name, symbol, coins, A, gamma, midFee, // %
+    outFee, // %
+    allowedExtraProfit, feeGamma, adjustmentStep, maHalfTime, // Seconds
+    initialPrice, implementationIdx = TwoCryptoImplementation.DEFAULT) {
+        return yield _deployTwocryptoPool.call(this, name, symbol, coins, A, gamma, midFee, outFee, allowedExtraProfit, feeGamma, adjustmentStep, maHalfTime, initialPrice, implementationIdx, true);
     });
 }
-export function deployTwocryptoPool(name, symbol, coins, A, gamma, midFee, // %
-outFee, // %
-allowedExtraProfit, feeGamma, adjustmentStep, maHalfTime, // Seconds
-initialPrice) {
-    return __awaiter(this, void 0, void 0, function* () {
-        return yield _deployTwocryptoPool.call(this, name, symbol, coins, A, gamma, midFee, outFee, allowedExtraProfit, feeGamma, adjustmentStep, maHalfTime, initialPrice, false);
+export function deployTwocryptoPool(name_1, symbol_1, coins_1, A_1, gamma_1, midFee_1, outFee_1, allowedExtraProfit_1, feeGamma_1, adjustmentStep_1, maHalfTime_1, initialPrice_1) {
+    return __awaiter(this, arguments, void 0, function* (name, symbol, coins, A, gamma, midFee, // %
+    outFee, // %
+    allowedExtraProfit, feeGamma, adjustmentStep, maHalfTime, // Seconds
+    initialPrice, implementationIdx = TwoCryptoImplementation.DEFAULT) {
+        return yield _deployTwocryptoPool.call(this, name, symbol, coins, A, gamma, midFee, outFee, allowedExtraProfit, feeGamma, adjustmentStep, maHalfTime, initialPrice, implementationIdx, false);
     });
 }
 export function getDeployedTwocryptoPoolAddress(tx) {

package/lib/index.d.ts

@@ -1,6 +1,7 @@
 import { ethers } from "ethers";
 import { PoolTemplate } from "./pools/index.js";
 import { deployCryptoPoolEstimateGas, deployTwocryptoPoolEstimateGas } from './factory/deploy.js';
+import { getTwoCryptoImplementations } from './constants/twoCryptoImplementations.js';
 export declare const createCurve: () => {
     init: (this: ReturnType<typeof createCurve>, providerType: "JsonRpc" | "Web3" | "Infura" | "Alchemy" | "NoRPC", providerSettings: "NoRPC" | {
         url?: string;
@@ -145,7 +146,7 @@ export declare const createCurve: () => {
         fetchPools: (useApi?: boolean) => Promise<void>;
         fetchNewPools: () => Promise<string[]>;
         getPoolList: () => string[];
-        deployPool: (name: string, symbol: string, coins: string[], A: string | number, gamma: string | number, midFee: string | number, outFee: string | number, allowedExtraProfit: string | number, feeGamma: string | number, adjustmentStep: string | number, maHalfTime: number, initialPrice: string | number) => Promise<ethers.ContractTransactionResponse>;
+        deployPool: (name: string, symbol: string, coins: string[], A: string | number, gamma: string | number, midFee: string | number, outFee: string | number, allowedExtraProfit: string | number, feeGamma: string | number, adjustmentStep: string | number, maHalfTime: number, initialPrice: string | number, implementationIdx?: import("./constants/twoCryptoImplementations.js").TwoCryptoImplementation | undefined) => Promise<ethers.ContractTransactionResponse>;
         deployGauge: (poolAddress: string) => Promise<ethers.ContractTransactionResponse>;
         deployGaugeSidechain: (poolAddress: string, salt: string) => Promise<ethers.ContractTransactionResponse>;
         deployGaugeMirror: (chainId: number, salt: string) => Promise<ethers.ContractTransactionResponse>;
@@ -155,6 +156,7 @@ export declare const createCurve: () => {
         getDeployedGaugeMirrorAddressByTx: (tx: ethers.ContractTransactionResponse) => Promise<string>;
         fetchRecentlyDeployedPool: (poolAddress: string) => Promise<string>;
         gaugeImplementation: () => string;
+        getImplementations: typeof getTwoCryptoImplementations;
         estimateGas: {
             deployPool: typeof deployTwocryptoPoolEstimateGas;
             deployGauge: (poolAddress: string) => Promise<number>;
@@ -454,7 +456,7 @@ declare const _default: {
         fetchPools: (useApi?: boolean) => Promise<void>;
         fetchNewPools: () => Promise<string[]>;
         getPoolList: () => string[];
-        deployPool: (name: string, symbol: string, coins: string[], A: string | number, gamma: string | number, midFee: string | number, outFee: string | number, allowedExtraProfit: string | number, feeGamma: string | number, adjustmentStep: string | number, maHalfTime: number, initialPrice: string | number) => Promise<ethers.ContractTransactionResponse>;
+        deployPool: (name: string, symbol: string, coins: string[], A: string | number, gamma: string | number, midFee: string | number, outFee: string | number, allowedExtraProfit: string | number, feeGamma: string | number, adjustmentStep: string | number, maHalfTime: number, initialPrice: string | number, implementationIdx?: import("./constants/twoCryptoImplementations.js").TwoCryptoImplementation | undefined) => Promise<ethers.ContractTransactionResponse>;
         deployGauge: (poolAddress: string) => Promise<ethers.ContractTransactionResponse>;
         deployGaugeSidechain: (poolAddress: string, salt: string) => Promise<ethers.ContractTransactionResponse>;
         deployGaugeMirror: (chainId: number, salt: string) => Promise<ethers.ContractTransactionResponse>;
@@ -464,6 +466,7 @@ declare const _default: {
         getDeployedGaugeMirrorAddressByTx: (tx: ethers.ContractTransactionResponse) => Promise<string>;
         fetchRecentlyDeployedPool: (poolAddress: string) => Promise<string>;
         gaugeImplementation: () => string;
+        getImplementations: typeof getTwoCryptoImplementations;
         estimateGas: {
             deployPool: typeof deployTwocryptoPoolEstimateGas;
             deployGauge: (poolAddress: string) => Promise<number>;

package/lib/index.js

@@ -14,6 +14,7 @@ import { Curve } from "./curve.js";
 import { getCrv, getLockedAmountAndUnlockTime, getVeCrv, getVeCrvPct, calcUnlockTime, createLockEstimateGas, createLock, isApproved, approveEstimateGas, approve, increaseAmountEstimateGas, increaseAmount, increaseUnlockTimeEstimateGas, increaseUnlockTime, withdrawLockedCrvEstimateGas, withdrawLockedCrv, claimableFees, claimFeesEstimateGas, claimFees, lastEthBlock, getAnycallBalance, topUpAnycall, topUpAnycallEstimateGas, lastBlockSent, blockToSend, sendBlockhash, sendBlockhashEstimateGas, submitProof, submitProofEstimateGas, claimFeesCrvUSDEstimateGas, claimableFeesCrvUSD, claimFeesCrvUSD, calculateVeCrv, } from "./boosting.js";
 import { getBalances, getAllowance, hasAllowance, ensureAllowanceEstimateGas, ensureAllowance, getUsdRate, getGasPriceFromL1, getGasPriceFromL2, getGasInfoForL2, getTVL, getCoinsData, getVolume, hasDepositAndStake, hasRouter, getBasePools, getGasPrice, getCurveLiteNetworks, } from "./utils.js";
 import { deployStablePlainPool, deployStablePlainPoolEstimateGas, getDeployedStablePlainPoolAddress, setOracle, setOracleEstimateGas, deployStableMetaPool, deployStableMetaPoolEstimateGas, getDeployedStableMetaPoolAddress, deployCryptoPool, deployCryptoPoolEstimateGas, getDeployedCryptoPoolAddress, deployTricryptoPool, deployTricryptoPoolEstimateGas, getDeployedTricryptoPoolAddress, deployGauge, deployGaugeEstimateGas, getDeployedGaugeAddress, deployGaugeSidechain, deployGaugeSidechainEstimateGas, deployGaugeMirror, deployGaugeMirrorEstimateGas, getDeployedGaugeMirrorAddress, getDeployedGaugeMirrorAddressByTx, deployStableNgPlainPool, deployStableNgPlainPoolEstimateGas, deployStableNgMetaPool, deployStableNgMetaPoolEstimateGas, deployTwocryptoPool, deployTwocryptoPoolEstimateGas, getDeployedTwocryptoPoolAddress, } from './factory/deploy.js';
+import { getTwoCryptoImplementations } from './constants/twoCryptoImplementations.js';
 import { crvSupplyStats, userCrv, userVeCrv, crvLockIsApproved, crvLockApproveEstimateGas, crvLockApprove, calcCrvUnlockTime, createCrvLockEstimateGas, createCrvLock, increaseCrvLockedAmountEstimateGas, increaseCrvLockedAmount, increaseCrvUnlockTimeEstimateGas, increaseCrvUnlockTime, withdrawLockedCrvEstimateGas as daoWithdrawLockedCrvEstimateGas, withdrawLockedCrv as daoWithdrawLockedCrv, claimableFees as daoClaimableFees, claimFeesEstimateGas as daoClaimFeesEstimateGas, claimFees as daoClaimFees, getVotingGaugeList, userGaugeVotes, voteForGaugeNextTime, voteForGaugeEstimateGas, voteForGauge, getProposalList, getProposal, userProposalVotes, voteForProposalEstimateGas, voteForProposal, executeVote, executeVoteEstimateGas, isCanVoteExecute, } from "./dao.js";
 export const createCurve = () => {
     const _curve = new Curve();
@@ -147,6 +148,7 @@ export const createCurve = () => {
             getDeployedGaugeMirrorAddressByTx: getDeployedGaugeMirrorAddressByTx.bind(_curve),
             fetchRecentlyDeployedPool: _curve.fetchRecentlyDeployedTwocryptoFactoryPool.bind(_curve),
             gaugeImplementation: () => _curve.getGaugeImplementation("factory-twocrypto"),
+            getImplementations: getTwoCryptoImplementations,
             estimateGas: {
                 deployPool: deployTwocryptoPoolEstimateGas, //
                 deployGauge: (poolAddress) => __awaiter(void 0, void 0, void 0, function* () { return deployGaugeEstimateGas.call(_curve, poolAddress, _curve.constants.ALIASES.twocrypto_factory); }),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@curvefi/api",
-  "version": "2.68.12",
+  "version": "2.68.13",
   "description": "JavaScript library for curve.finance",
   "main": "lib/index.js",
   "author": "Macket",