GithubHelp home page GithubHelp logo

ohhkaneda / curve-stablecoin-js Goto Github PK

View Code? Open in Web Editor NEW

This project forked from curvefi/curve-stablecoin-js

0.0 0.0 0.0 26 KB

JavaScript library for Curve Stablecoin

License: MIT License

TypeScript 100.00%

curve-stablecoin-js's Introduction

CRVUSD JS

Setup

Install from npm:

npm install @curvefi/stablecoin-api

Init

import crvusd from "@curvefi/stablecoin-api";

(async () => {
    // 1. Dev
    await crvusd.init('JsonRpc', {url: 'http://localhost:8545/', privateKey: ''}, { gasPrice: 0, maxFeePerGas: 0, maxPriorityFeePerGas: 0, chainId: 1 });
    // OR
    await crvusd.init('JsonRpc', {}, {}); // In this case JsonRpc url, privateKey, fee data and chainId will be specified automatically

    // 2. Infura
    crvusd.init("Infura", { network: "homestead", apiKey: <INFURA_KEY> }, { chainId: 1 });
    
    // 3. Web3 provider
    crvusd.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

Note 2. Web3 init requires the address. Therefore, it can be initialized only after receiving the address.

Wrong ❌️

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 crvusd from '@curvefi/stablecoin-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) {
                            crvusd.init("Web3", { externalProvider: wallet.provider }, { chainId: networkId })
                        }
                    },
                },
                walletSelect: {
                    wallets: wallets,
                },
            }),
        []
    )

    ...

Right ✔️

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 crvusd from '@curvefi/stablecoin-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) {
            crvusd.init("Web3", { externalProvider: wallet.provider }, { chainId: networkId })
        }
    }, [address, wallet?.provider]);

    ...

Notes

  • 1 Amounts can be passed in args either as numbers or strings.
  • 2 llamma.swapPriceImpact method returns %, e. g. 0 < priceImpact <= 100.
  • 3 Slippage arg should be passed as %, e. g. 0 < slippage <= 100.

General methods

import crvusd from "@curvefi/stablecoin-api";

(async () => {
    await crvusd.init('JsonRpc', {});
    
    const balances1 = await crvusd.getBalances(['crvusd', 'weth']);
    // OR const balances1 = await crvusd.getBalances(['0xe0aA552A10d7EC8760Fc6c246D391E698a82dDf9', '0xE7eD6747FaC5360f88a2EFC03E00d25789F69291']);
    console.log(balances1);
    // [ '10000.0', '0.0' ]

    // You can specify the address
    const balances2 = await crvusd.getBalances(['crvusd', 'weth'], "0x0063046686E46Dc6F15918b61AE2B121458534a5");
    // OR const balances2 = await crvusd.getBalances(['0x028171bCA77440897B824Ca71D1c56caC55b68A3', '0x6c5024cd4f8a59110119c56f8933403a539555eb'], '0x0063046686E46Dc6F15918b61AE2B121458534a5');
    console.log(balances2);
    // [ '0.0', '0.0' ]

    
    const spender = "0x431e47D68ED6F82534d3af78cC175a54B3fCA89b";

    await crvusd.getAllowance(["crvusd", "weth"], crvusd.signerAddress, spender);
    // [ '0.0', '0.0' ]
    await crvusd.hasAllowance(["crvusd", "weth"], ['1000', '1000'], crvusd.signerAddress, spender);
    // false
    await crvusd.ensureAllowance(["crvusd", "weth"], ['1000', '1000'], spender);
    // [
    //     '0xb0cada2a2983dc0ed85a26916d32b9caefe45fecde47640bd7d0e214ff22aed3',
    //     '0x00ea7d827b3ad50ce933e96c579810cd7e70d66a034a86ec4e1e10005634d041'
    // ]
})()

Llammas

Llamma fields

import crvusd from "@curvefi/stablecoin-api";

(async () => {
    await crvusd.init('JsonRpc', {});

    const llamma = crvusd.getLlamma('eth');

    llamma.id;
    // eth
    llamma.address;
    // 0x431e47d68ed6f82534d3af78cc175a54b3fca89b
    llamma.controller;
    // 0x8fcc5562719f201220fee35a874867627d653f45
    llamma.collateralDecimals;
    // 18
    llamma.coinAddresses;
    // [
    //     '0xe0aa552a10d7ec8760fc6c246d391e698a82ddf9',
    //     '0xe7ed6747fac5360f88a2efc03e00d25789f69291'
    // ]
    llamma.coinDecimals;
    // [ 18, 18 ]
    llamma.minTicks;
    // 5
    llamma.maxTicks;
    // 50
})()

Wallet balances for llamma

import crvusd from "@curvefi/stablecoin-api";

(async () => {
    await crvusd.init('JsonRpc', {});
    
    const llamma = crvusd.getLlamma('eth');
    
    // 1. Current address (signer) balances

    await llamma.wallet.balances();
    // { stablecoin: '0.0', collateral: '1.0' }

    
    // 2. You can specify the address
    
    await saave.wallet.balances("0x0063046686E46Dc6F15918b61AE2B121458534a5");
    // { stablecoin: '0.0', collateral: '0.0' }
})()

Stats

import crvusd from "@curvefi/stablecoin-api";

(async () => {
    await crvusd.init('JsonRpc', {});

    const llamma = crvusd.getLlamma('eth');

    await llamma.stats.parameters();
    // {
    //     A: '100',
    //     fee: '0.0',
    //     admin_fee: '0.0',
    //     rate: '0.0',
    //     min_band: '0',
    //     max_band: '15',
    //     active_band: '11',
    //     minted: '5428.767016666357716798',
    //     redeemed: '4053.027016666357716798',
    //     liquidation_discount: '2.0',
    //     loan_discount: '5.0'
    // }
    await llamma.stats.balances();
    // [ '300.0', '0.402268776965776345' ]
    await llamma.stats.bandBalances();
    // {
    //     '0': { stablecoin: '0.0', collateral: '0.0' },
    //     '1': { stablecoin: '0.0', collateral: '0.0' },
    //     '2': { stablecoin: '0.0', collateral: '0.0' },
    //     '3': { stablecoin: '0.0', collateral: '0.0' },
    //     '4': { stablecoin: '0.0', collateral: '0.0' },
    //     '5': { stablecoin: '0.0', collateral: '0.0' },
    //     '6': { stablecoin: '0.0', collateral: '0.0' },
    //     '7': { stablecoin: '0.0', collateral: '0.0' },
    //     '8': { stablecoin: '0.0', collateral: '0.0' },
    //     '9': { stablecoin: '0.0', collateral: '0.0' },
    //     '10': { stablecoin: '0.0', collateral: '0.0' },
    //     '11': { stablecoin: '300.0', collateral: '0.002268776965776345' },
    //     '12': { stablecoin: '0.0', collateral: '0.1' },
    //     '13': { stablecoin: '0.0', collateral: '0.1' },
    //     '14': { stablecoin: '0.0', collateral: '0.1' },
    //     '15': { stablecoin: '0.0', collateral: '0.1' }
    // }
    await llamma.stats.totalDebt();
    // 1375.74
})()

Create loan, add collateral, borrow more, repay

(async () => {
    await crvusd.init('JsonRpc', {});

    const llamma = crvusd.getLlamma('eth');
    
    
    // --- CREATE LOAN ---

    await llamma.oraclePrice();
    // 3000.0
    await llamma.basePrice();
    // 3328.767218409119949
    await llamma.price();
    // 2735.219440342170202508
    await llamma.wallet.balances();
    // { stablecoin: '0.0', collateral: '1.0' }
    await llamma.createLoanMaxRecv(0.5, 5);
    // 1375.74670276529114147
    await llamma.createLoanTicks(0.5, 1000, 5);
    // [ 43, 47 ]
    await llamma.createLoanPrices(0.5, 1000, 5);
    // [ '2160.711488947208628756', '2054.815126693409139409' ]
    await llamma.createLoanIsApproved(0.5);
    // false
    await llamma.createLoanApprove(0.5);
    // [
    //     '0xc111e471715ae6f5437e12d3b94868a5b6542cd7304efca18b5782d315760ae5'
    // ]
    await llamma.createLoan(0.5, 1000, 5);

    await llamma.debt();  // OR await llamma.debt(address);
    // 1000.0
    await llamma.loanExists();
    // true
    await llamma.health();
    // 45.2226644923786951 %
    await llamma.userTicks();
    // [ 43, 47 ]
    await llamma.userPrices();
    // [ '2160.711488947208628756', '2054.815126693409139409' ]
    await llamma.userState();
    // { collateral: '0.5', stablecoin: '0.0', debt: '1000.0' }

    // --- ADD COLLATERAL ---

    await llamma.addCollateralTicks(0.2);
    // [ 76, 80 ]
    await llamma.addCollateralPrices(0.2);
    // [ '1550.808607753146112068', '1474.803555272329779679' ]
    await llamma.addCollateralIsApproved(0.2);
    // true
    await llamma.addCollateralApprove(0.2);
    // []
    await llamma.addCollateral(0.2);  // OR await llamma.addCollateral(0.2, forAddress);

    // Health: 105.1996246184004855 %
    // Ticks: [ 76, 80 ]
    // Prices: [ '1550.808607753146112068', '1474.803555272329779679' ]
    // State: { collateral: '0.7', stablecoin: '0.0', debt: '1000.0' }
    
    // --- BORROW MORE ---

    await llamma.borrowMoreMaxRecv(0.1);
    // 1201.194724424465848923
    await llamma.borrowMoreTicks(0.1, 500);
    // [ 49, 53 ]

    await llamma.borrowMorePrices(0.1, 500);
    // [ '2034.266975426474972053', '1934.567652470744468892' ]
    await llamma.borrowMoreIsApproved(0.1);
    // true
    await llamma.borrowMoreApprove(0.1);
    // []
    await llamma.borrowMore(0.1, 500);

    // Health: 55.2023824864885161
    // Ticks: [ 49, 53 ]
    // Prices: [ '2034.266975426474972053', '1934.567652470744468892' ]
    // State: { collateral: '0.8', stablecoin: '0.0', debt: '1500.0' }

    // --- REPAY ---

    await llamma.wallet.balances();
    // { stablecoin: '1500.0', collateral: '0.2' }

    await llamma.repayIsApproved(1000);
    await llamma.repayApprove(1000);
    await llamma.repay(1000);

    // Health: 375.2354895737620483 %
    // Ticks: [ 159, 163 ]
    // Prices: [ '673.40967934429197419', '640.405904562216960151' ]
    // State: { collateral: '0.8', stablecoin: '0.0', debt: '500.0' }
})()

Swap

(async () => {
    await crvusd.init('JsonRpc', {});

    const llamma = crvusd.getLlamma('eth');

    await llamma.wallet.balances();
    // {
    //     stablecoin: '301.533523886491869218',
    //     collateral: '0.860611976623971606'
    // }


    await llamma.maxSwappable(0, 1);
    // 380.672763174593107707
    await llamma.swapExpected(0, 1, 100);
    // 0.03679356627103543
    await llamma.swapPriceImpact(0, 1, 100);
    // 0.170826
    await llamma.swapIsApproved(0, 100);
    // true
    await llamma.swapApprove(0, 100);
    // []
    await llamma.swap(0, 1, 100, 0.1);

    await llamma.wallet.balances();
    // {
    //     stablecoin: '201.533523886491869218',
    //     collateral: '0.897405542895007036'
    // }
})()

Self-liquidation

(async () => {
    await crvusd.init('JsonRpc', {});

    const llamma = crvusd.getLlamma('eth');

    // Wallet balances: {
    //     stablecoin: '301.533523886491869218',
    //     collateral: '0.860611976623971606'
    // }
    // State: {
    //     collateral: '0.139388023376028394',
    //     stablecoin: '2751.493405530582315609',
    //     debt: '3053.026929417074184827'
    // }
    
    await llamma.tokensToLiquidate();
    // 301.533523886491869218
    await llamma.selfLiquidateIsApproved();
    // true
    await llamma.selfLiquidateApprove();
    // []
    await llamma.selfLiquidate(0.1); // slippage = 0.1 %

    // Wallet balances: { stablecoin: '0.0', collateral: '1.0' }
    // State: { collateral: '0.0', stablecoin: '0.0', debt: '0.0' }
})()

Liquidation

(async () => {
    await crvusd.init('JsonRpc', {});

    const llamma = crvusd.getLlamma('eth');
    const addressToLiquidate = "0x66aB6D9362d4F35596279692F0251Db635165871";

    await llamma.wallet.balances();
    // Liquidator wallet balances: {
    //     stablecoin: '301.533523886491869218',
    //     collateral: '0.860611976623971606'
    // }
    await llamma.userState(addressToLiquidate);
    // State of the account we are goning to liquidate: {
    //     collateral: '0.139388023376028394',
    //     stablecoin: '2751.493405530582315609',
    //     debt: '3053.026929417074184827'
    // }
    
    await llamma.tokensToLiquidate(addressToLiquidate);
    // 301.533523886491869218
    await llamma.liquidateIsApproved();
    // true
    await llamma.liquidateApprove();
    // []
    await llamma.liquidate(addressToLiquidate, 0.1); // slippage = 0.1 %

    // Liquidator wallet balances: { stablecoin: '0.0', collateral: '1.0' }
    // State of liquidated account: { collateral: '0.0', stablecoin: '0.0', debt: '0.0' }
})()

Gas estimation

Every non-constant method has corresponding gas estimation method. Rule: obj.method -> obj.estimateGas.method

Examples

import crvusd from "@curvefi/stablecoin-api";

(async () => {
    await crvusd.init('JsonRpc', {});
    
    const spender = "0x431e47D68ED6F82534d3af78cC175a54B3fCA89b";
    await crvusd.estimateGas.ensureAllowance(["weth"], [1], spender);
    // 94523
    
    const llamma = crvusd.getLlamma('eth');
    await llamma.estimateGas.createLoanApprove(0.5);
    // 186042
    await llamma.estimateGas.createLoan(0.5, 1000, 20);
    // 1306411
})()

curve-stablecoin-js's People

Contributors

macket avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.