Curve Finance

https://docs.curve.finance
Admin
Curve Finance is a decentralized exchange (DEX) powered by automated market makers (AMMs) designed...
Tokens:992,522
Snippets:6,972
Trust Score:9.6
Update:2 months ago
Show doc for...
Tokens:
Raw
### Get Balances and Remove Liquidity Example

Source: https://docs.curve.finance/developer/amm/stableswap-ng/pools/plainpool

Example showing how to check pool balances and remove liquidity.

```python
>>> StableSwap.get_balances()  
[1156170050330410764719488, 1052703857490]  
>>> StableSwap.remove_liquidity(10**18, [0, 0])  
523455207306501616, 476610
```

--------------------------------

### Example Usage

Source: https://docs.curve.finance/developer/crvusd/leverage/leverage-zap

Example call to calculate_debt_n1.

```python
>>> LeverageZap.calculate_debt_n1(100000000, 300000000000000000000000. 4, 0)  
-60  
```

--------------------------------

### Mint Example

Source: https://docs.curve.finance/developer/amm/legacy/cryptoswap/lp-tokens/lp-token-v5

Example usage of the mint method.

```Python
>>> LPTokenV5.mint("todo")  
"todo"  
```

--------------------------------

### Example usage

Source: https://docs.curve.finance/developer/amm/stableswap-ng/utility-contracts/views

A placeholder example for calling the function.

```Python
>>> StableSwap.get_y('todo')
'todo'
```

--------------------------------

### Example Usage

Source: https://docs.curve.finance/developer/lending/contracts/crypto-from-pool-vault

Example of calling the price_w function.

```Python
>>> CryptoFromPoolVault.price_w()  
1046959880335267532
```

--------------------------------

### Get Swap Into Synth Amount Usage Example

Source: https://docs.curve.finance/developer/amm/legacy/stableswap/cross-asset-swaps/synthswap-exchange

Example usage of the get_swap_into_synth_amount method in a Python environment.

```python
>>> synth_swap = Contract('0x58A3c68e2D3aAf316239c003779F71aCb870Ee47')  
>>> dai = Contract('0x6b175474e89094c44da98b954eedeac495271d0f')  
>>> sbtc = Contract('0xfe18be6b3bd88a2d2a7f928d00292e7a9963cfc6')  
  
>>> synthswap.get_swap_into_synth_amount(dai, sbtc, 100000 * 1e18)  
2720559215249173192
```

--------------------------------

### Get Swap From Synth Amount Usage Example

Source: https://docs.curve.finance/developer/amm/legacy/stableswap/cross-asset-swaps/synthswap-exchange

Example usage of the get_swap_from_synth_amount method in a Python environment.

```python
>>> synth_swap = Contract('0x58A3c68e2D3aAf316239c003779F71aCb870Ee47')  
>>> sbtc = Contract('0xfe18be6b3bd88a2d2a7f928d00292e7a9963cfc6')  
>>> wbtc = Contract('0x2260fac5e5542a773aa44fbcfedf7c193bc2c599')  
  
>>> synthswap.get_swap_from_synth_amount(sbtc, wbtc, 2720559215249173192)  
273663013
```

--------------------------------

### Execute take_snapshot Example

Source: https://docs.curve.finance/developer/scrvusd/rewards-handler

Example usage of the take_snapshot function.

```Python
>>> RewardsHandler.take_snapshot()
```

--------------------------------

### Add Liquidity Console Example

Source: https://docs.curve.finance/developer/amm/legacy/stableswap/pools/plain-pools

Placeholder for console output example.

```text
>>> todo: add_liquidity console output example
```

--------------------------------

### Get BlockHash Example

Source: https://docs.curve.finance/developer/scrvusd/crosschain/oracle-v0

Example usage of the get_block_hash function, demonstrating successful retrieval and revert behavior.

```Python
>>> BlockHashOracle.get_block_hash(21192041)  
'0x9db78f319e1bfde9cb0723b6e96de3dce6d378b01b341a5e45546ac4b7f7269a'  
  
>>> BlockHashOracle.get_block_hash(21192042)  
Error: Returned error: execution reverted
```

--------------------------------

### Delegation Management Examples

Source: https://docs.curve.finance/developer/curve-dao/voting-escrow/crosschain/vecrv-delegation

Examples demonstrating how to allow or revoke delegation permissions.

```python
>>> L2veCRVDelegation.allow_delegation(146, True)       # Allow delegation to your address on chain 146  
  
>>> L2veCRVDelegation.allow_delegation(146, False)      # Revoke delegation  
```

--------------------------------

### Example Usage of verifyPeriodByStateRoot

Source: https://docs.curve.finance/developer/scrvusd/crosschain/oracle-v2/verifier

A basic example showing how to call the verifyPeriodByStateRoot function.

```python
>>> ScrvusdVerifierV2.verifyPeriodByStateRoot(21192041, proof_rlp)  
```

--------------------------------

### Preview Redeem Example

Source: https://docs.curve.finance/developer/lending/contracts/vault

Example usage of the previewRedeem function.

```Python
>>> Vault.previewRedeem(1000000000000000000):  
1001293138709678
```

--------------------------------

### Calculate Token Fee Example

Source: https://docs.curve.finance/developer/amm/tricrypto-ng/pools/tricrypto

Example usage for calculating the token fee.

```Python
>>> TriCrypto.calc_token_fee()  
'todo'
```

--------------------------------

### Initial A/Gamma Usage Example

Source: https://docs.curve.finance/developer/amm/twocrypto-ng/pools/twocrypto

Example of calling the initial_A_gamma getter.

```Python
>>> TwoCrypto.initial_A_gamma()  
581076037942835227425498917514114728328226821
```

--------------------------------

### Add Liquidity Usage Example

Source: https://docs.curve.finance/developer/amm/legacy/stableswap/pools/lending-pools

A basic example of calling the add_liquidity method.

```Python
>>> lending_pool.add_liquidity()  
todo: console output
```

--------------------------------

### Get Caller Share Example

Source: https://docs.curve.finance/developer/crvusd/pegkeepers/peg-keeper-v1

Example usage of the caller_share getter.

```Python
>>> PegKepper.caller_share()  
20000
```

--------------------------------

### Setting Receivers Examples

Source: https://docs.curve.finance/developer/fees/FeeSplitter

Examples demonstrating how to configure receiver addresses and weights, including adding new receivers to an existing set.

```python
>>> FeeSplitter.set_receivers([  
    ("0x70CCBE10F980d80b7eBaab7D2E3A73e87D67B775", 1000),   
    ("0xa2Bcd1a4Efbd04B63cd03f5aFf2561106ebCCE00", 9000)])  
```

```python
>>> FeeSplitter.set_receivers([  
    ("0x70CCBE10F980d80b7eBaab7D2E3A73e87D67B775", 1000),  
    ("0x1234567890123456789012345678901234567890", 1000),  
    ("0xa2Bcd1a4Efbd04B63cd03f5aFf2561106ebCCE00", 8000)])  
```

--------------------------------

### Initialize Method Usage Example

Source: https://docs.curve.finance/developer/amm/legacy/cryptoswap/lp-tokens/lp-token-v5

Example of calling the initialize method on the LPTokenV5 contract.

```python
>>> LPTokenV5.initialize("todo")
```

--------------------------------

### Get Virtual Price Example

Source: https://docs.curve.finance/developer/amm/twocrypto-ng/pools/oracles

Example usage of the get_virtual_price method in a console environment.

```python
>>> CurveTwocryptoOptimized.get_virtual_price()  
1000270251060292804
```

--------------------------------

### Price Retrieval Example

Source: https://docs.curve.finance/developer/lending/contracts/crypto-from-pool-vault

Example output of calling the price function.

```python
>>> CryptoFromPoolVault.price()  
1046959880335267532
```

--------------------------------

### Install curve-voting-lib

Source: https://docs.curve.finance/developer/curve-dao/governance/voting-library

Commands to clone the repository and set up the environment using uv.

```bash
git clone https://github.com/curvefi/curve-voting-lib.git  
cd curve-voting-lib  
uv sync  
uv run python -m pip install -e .  
```

--------------------------------

### Apply BlockHash Example

Source: https://docs.curve.finance/developer/scrvusd/crosschain/oracle-v0

Example usage of the apply function.

```Python
>>> BlockHashOracle.apply()
```

--------------------------------

### Example usage of deploy_plain_pool

Source: https://docs.curve.finance/developer/amm/legacy/factory/stableswap/deployer-api

A Python-style example demonstrating how to call the deploy_plain_pool function with specific parameters.

```python
>>> Factory.deploy_plain_pool(  
    _name: "alUSD-crvUSD",  
    _symbol: "alcrvUSD",  
    _coins: ['0xbc6da0fe9ad5f3b0d58160288917aa56653660e9', '0xf939E0A03FB07F59A73314E73794Be0E57ac1b4E'],  
    _A: 200,  
    _fee: 4000000,  
    _asset_type: 0,  
    _implementation_idx: 0,  
    )      
  
'returns address of deployed pool'
```

--------------------------------

### remove_liquidity console example

Source: https://docs.curve.finance/developer/amm/legacy/stableswap/pools/plain-pools

Placeholder for console output example.

```text
>>> todo: remove_liquidity console output example
```

--------------------------------

### Example Usage of create

Source: https://docs.curve.finance/developer/lending/contracts/oneway-factory

An example call to the create method showing the required parameters and the returned vault address.

```python
>>> OneWayLendingVaultFactory.create(  
        "0xf939e0a03fb07f59a73314e73794be0e57ac1b4e",       # borrowed_token  
        "0x8f22779662ad253844013d8e99eccb4d80e31417",       # collateral_token  
        50,                                                 # A  
        6000000000000000,                                   # fee  
        140000000000000000,                                 # loan_discount  
        110000000000000000,                                 # liquidation_discount  
        external price oracle,                              # price_oracle  
        "bobrCRV-long",                                     # name  
        0,                                                  # min_borrow_rate  
        1)                                                  # max_borrow_rate  
  
'0xE16D806c4198955534d4EB10E4861Ea94557602E'                # returns address of the created vault
```

--------------------------------

### Get AMM Price Usage Example

Source: https://docs.curve.finance/developer/crvusd/amm

Example call to the get_p function returning the current collateral price.

```Python
>>> AMM.get_p()  
3215032751001233561432
```

--------------------------------

### Execute price_oracle example

Source: https://docs.curve.finance/developer/amm/stableswap-ng/pools/oracles

Example usage of the price_oracle function.

```python
>>> StableSwap.price_oracle(0)  
1000187813326452556
```

--------------------------------

### Execute D_oracle example

Source: https://docs.curve.finance/developer/amm/stableswap-ng/pools/oracles

Example usage of the D_oracle function.

```python
>>> StableSwap.D_oracle()  
2183776033162328612308290
```

--------------------------------

### Controller Factory Getter Example

Source: https://docs.curve.finance/developer/crvusd/controller

Example usage of the Controller.factory() method.

```Python
>>> Controller.factory()  
'0xC9332fdCB1C491Dcc683bAe86Fe3cb70360738BC  
```

--------------------------------

### previewWithdraw Usage Example

Source: https://docs.curve.finance/developer/lending/contracts/vault

Example of simulating a withdrawal of 1 crvusd.

```python
>>> Vault.previewWithdraw(1000000000000000000):     # withdrawing 1 crvusd  
998540201056049850914                               # shares to burn (approx. 988)
```

--------------------------------

### remove_liquidity_imbalance example placeholder

Source: https://docs.curve.finance/developer/amm/legacy/stableswap/pools/plain-pools

Placeholder for console output example.

```text
>>> todo: remove_liquidity_imbalance console output example
```

--------------------------------

### Add Market Example

Source: https://docs.curve.finance/developer/crvusd/factory

Example usage of adding a market to the ControllerFactory.

```Python
>>> ControllerFactory.add_market("0xae78736cd615f374d3085123a210448e74fc6393",  
                                100,  
                                6000000000000000,  
                                0,  
                                "price oracle contract",  
                                "monetary policy contract",  
                                90000000000000000,  
                                60000000000000000,  
                                10000000000000000000000000):  
  
"returns AMM and Controller contract"
```

--------------------------------

### Example usage of swap_from_synth

Source: https://docs.curve.finance/developer/amm/legacy/stableswap/cross-asset-swaps/synthswap-exchange

A Python-based example showing how to interact with the swap_from_synth function using Brownie or a similar framework.

```python
>>> wbtc = Contract('0x2260fac5e5542a773aa44fbcfedf7c193bc2c599')  
  
>>> amount = synth_swap.token_info(token_id)['underlying_balance']  
>>> expected = swynth_swap.get_swap_from_synth_amount(sbtc, wbtc, amount) * 0.99  
  
>>> synth_swap.swap_from_synth(token_id, wbtc, amount, expected, {'from': alice})  
Transaction sent: 0x83b311af19be08b8ec6241c3e834ccdf3b22586971de82a76a641e43bdf2b3ee  
  Gas price: 20 gwei   Gas limit: 800000   Nonce: 6
```

--------------------------------

### Get Future A Time

Source: https://docs.curve.finance/developer/amm/stableswap-ng/pools/metapool

Example usage of the future_A_time getter.

```Python
>>> StableSwap.future_A_time()  
0  
```

--------------------------------

### Set Fee Receiver Example

Source: https://docs.curve.finance/developer/amm/factory/twocrypto-ng/overview

Placeholder example for setting the fee receiver.

```python
>>> soon
```

--------------------------------

### Get Initial A Time

Source: https://docs.curve.finance/developer/amm/stableswap-ng/pools/metapool

Example usage of the initial_A_time getter.

```Python
>>> StableSwap.initial_A_time()  
0  
```

--------------------------------

### Execute flashFee examples

Source: https://docs.curve.finance/developer/crvusd/flash-lender

Demonstrates successful fee retrieval for crvUSD and revert behavior for unsupported tokens.

```python
>>> FlashLender.flashFee('0xf939E0A03FB07F59A73314E73794Be0E57ac1b4E', 100000 * 10**18)  
0  
  
>>> FlashLender.flashFee('0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48', 100000 * 10**18)  
reverts: "FlashLender: Unsupported currency"
```

--------------------------------

### ScrvusdProver Execution Example

Source: https://docs.curve.finance/developer/scrvusd/crosschain/oracle-v0

Example of calling the prove function with RLP-encoded parameters.

```Python
>>> ScrvusdProver.prove(block_header_rlp, proof_rlp)
```

--------------------------------

### Get Future A Value

Source: https://docs.curve.finance/developer/amm/stableswap-ng/pools/metapool

Example usage of the future_A getter.

```Python
>>> StableSwap.future_A()  
500  
```

--------------------------------

### Example Placeholder

Source: https://docs.curve.finance/developer/amm/legacy/stableswap/deposit-contracts/metapool-deposits

A placeholder example block provided in the source documentation.

```text
>>> todo:  
```

--------------------------------

### Get donation_duration

Source: https://docs.curve.finance/developer/amm/twocrypto-ng/implementations/refuel

Example usage of the getter for the donation duration.

```Python
>>> FXSwap.donation_duration()  
604800
```

--------------------------------

### Get Future Epoch Start Time

Source: https://docs.curve.finance/developer/curve-dao/crv-token

Retrieves the next mining epoch start timestamp, triggering a parameter update if the reduction time has passed.

```Vyper
@external  
def future_epoch_time_write() -> uint256:  
    """  
    @notice Get timestamp of the next mining epoch start  
            while simultaneously updating mining parameters  
    @return Timestamp of the next epoch  
    """  
    _start_epoch_time: uint256 = self.start_epoch_time  
    if block.timestamp >= _start_epoch_time + RATE_REDUCTION_TIME:  
        self._update_mining_parameters()  
        return self.start_epoch_time + RATE_REDUCTION_TIME  
    else:  
        return _start_epoch_time + RATE_REDUCTION_TIME
```

```python
>>> CRV.future_epoch_time_write()  
1723161600
```

--------------------------------

### Example Usage of deploy_metapool

Source: https://docs.curve.finance/developer/amm/legacy/factory/stableswap/deployer-api

A demonstration of how to call the deploy_metapool function with specific parameters.

```python
>>> Factory.deploy_metapool(  
    _base_pool: '0xbEbc44782C7dB0a1A60Cb6fe97d0b483032FF1C7',  
    _name: "crvusd/3CRV",  
    _symbol: "crvUSD3CRV",  
    _coin: '0xf939E0A03FB07F59A73314E73794Be0E57ac1b4E',  
    _A: 200,  
    _fee: 4000000,  
    _implementation_idx: uint256 = 0,  
    )  
  
'returns address of the deployed pool'
```

--------------------------------

### Set Stablecoin Lens Usage Example

Source: https://docs.curve.finance/developer/scrvusd/rewards-handler

Example demonstrating how to update the stablecoin lens address.

```python
>>> RewardsHandler.stablecoin_lens()  
'0xe24e2dB9f6Bb40bBe7c1C025bc87104F5401eCd7'  
  
>>> RewardsHandler.set_stablecoin_lens('0x0000000000000000000000000000000000000000')  
  
>>> RewardsHandler.stablecoin_lens()  
'0x0000000000000000000000000000000000000000'  
```

--------------------------------

### Get Current Epoch Start Time

Source: https://docs.curve.finance/developer/curve-dao/crv-token

Retrieves the current mining epoch start timestamp, triggering a parameter update if the reduction time has passed.

```Vyper
start_epoch_time: public(uint256)  
  
@external  
def start_epoch_time_write() -> uint256:  
    """  
    @notice Get timestamp of the current mining epoch start  
            while simultaneously updating mining parameters  
    @return Timestamp of the epoch  
    """  
    _start_epoch_time: uint256 = self.start_epoch_time  
    if block.timestamp >= _start_epoch_time + RATE_REDUCTION_TIME:  
        self._update_mining_parameters()  
        return self.start_epoch_time  
    else:  
        return _start_epoch_time
```

```python
>>> CRV.start_epoch_time_write()  
1691625600
```

--------------------------------

### Set Views Implementation Example

Source: https://docs.curve.finance/developer/amm/factory/stableswap-ng/overview

Example usage of the set_views_implementations function.

```python
>>> CurveStableSwapFactoryNG.set_views_implementations('todo')  
```

--------------------------------

### JavaScript Example for users_to_liquidate

Source: https://docs.curve.finance/developer/llamalend-v2/lend-controller-view

Example usage of the users_to_liquidate function using ethers.js.

```javascript
const contract = new Contract('0xcda563f85388e621e7d810387e5afdac5d395e2b', LendControllerViewAbi, provider)
const result = await contract.users_to_liquidate(
  /* _from: uint256 */ 0n,
  /* _limit: uint256 */ 0n,
)
```

--------------------------------

### Get Monetary Policy Address

Source: https://docs.curve.finance/developer/crvusd/controller

Example usage of the monetary_policy getter.

```Python
>>> Controller.monetary_policy()  
'0x8c5A7F011f733fBb0A6c969c058716d5CE9bc933'  
```

--------------------------------

### Add Liquidity Example

Source: https://docs.curve.finance/developer/amm/stableswap-ng/pools/plainpool

Example of adding liquidity to a StableSwap pool.

```python
>>> StableSwap.add_liquidity([10000000000000000000, 0], 0)  
9997967030080774869
```

--------------------------------

### Get Regulator Address

Source: https://docs.curve.finance/developer/crvusd/pegkeepers/peg-keeper-v2

Example usage of the regulator getter function.

```python
>>> PegKeeperV2.regulator()  
'0x36a04CAffc681fa179558B2Aaba30395CDdd855f'  
```

--------------------------------

### Minimum Rate Usage Example

Source: https://docs.curve.finance/developer/lending/contracts/semilog-mp

Example showing how to query the current minimum rate.

```python
In  [1]:  SemilogMonetaryPolicy.min_rate()  
Out [1]:  158548959
```

--------------------------------

### Permit Usage Example

Source: https://docs.curve.finance/developer/amm/legacy/cryptoswap/lp-tokens/lp-token-v5

Example usage of the permit function.

```python
>>> LPTokenV5.permit()  
"todo"
```

--------------------------------

### Claim Rewards Usage Example

Source: https://docs.curve.finance/developer/gauges/gauges/liquidity-gauge-v6

Example of calling the claim_rewards function.

```Python
>>> LiquidityGaugeV6.claim_rewards('0x989AEb4d175e16225E39E87d0D97A3360524AD80')
```

--------------------------------

### PriceAggregator3 Execution Example

Source: https://docs.curve.finance/developer/crvusd/price-aggregator

Example output of calling the price method.

```Python
>>> PriceAggregator3.price()
999812685870581476
```

--------------------------------

### Example usage of set_debt_ceiling

Source: https://docs.curve.finance/developer/crvusd/factory

Example call to the set_debt_ceiling function.

```Python
>>> ControllerFactory.set_debt_ceiling(20000000000000000000000000)
```

--------------------------------

### Get donation_protection_period

Source: https://docs.curve.finance/developer/amm/twocrypto-ng/implementations/refuel

Example usage of the getter for the donation protection period.

```Python
>>> FXSwap.donation_protection_period()  
600
```

--------------------------------

### Get Contract Admin

Source: https://docs.curve.finance/developer/amm/stableswap-ng/implementations/custom1

Example usage of the admin getter method.

```python
>>> CurveStableSwap.admin()  
'0x0000000000000000000000000000000000000000'
```

--------------------------------

### Last Price Retrieval Example

Source: https://docs.curve.finance/developer/crvusd/oracles/price-aggregator

Example output of the last_price getter.

```Python
>>> PriceAggregator3.last_price()
999812852363656433
```

--------------------------------

### Price Function Examples

Source: https://docs.curve.finance/developer/crvusd/oracles/crypto-from-pool-vault-w-agg

Example usage of the price retrieval functions.

```Python
>>> CryptoFromPoolVaultWAgg.price()  
1020187011799809503
```

```Python
>>> CryptoFromPoolVaultWAgg.price_w()  
1020187011799809503
```

--------------------------------

### Get donation_protection_lp_threshold

Source: https://docs.curve.finance/developer/amm/twocrypto-ng/implementations/refuel

Example usage of the getter for the donation protection LP threshold.

```Python
>>> FXSwap.donation_protection_lp_threshold()  
200000000000000000          # 20%
```

--------------------------------

### Vault Deposit Examples

Source: https://docs.curve.finance/developer/lending/contracts/vault

Interactive console examples demonstrating deposit operations and balance changes.

```python
In  [1]:  Vault.balanceOf(trader)  
Out [1]:  0  
  
In  [2]:  Vault.deposit(1000000000000000000)  
  
In  [3]:  Vault.balanceOf(trader)  
Out [3]:  997552662404145514069  
```

--------------------------------

### Get donation_protection_expiry_ts

Source: https://docs.curve.finance/developer/amm/twocrypto-ng/implementations/refuel

Example usage of the getter for the donation protection expiry timestamp.

```Python
>>> FXSwap.donation_protection_expiry_ts()  
0
```

--------------------------------

### Get last_donation_release_ts

Source: https://docs.curve.finance/developer/amm/twocrypto-ng/implementations/refuel

Example usage of the getter for the last donation release timestamp.

```Python
>>> FXSwap.last_donation_release()  
1756389447
```

--------------------------------

### Get donation_shares_max_ratio

Source: https://docs.curve.finance/developer/amm/twocrypto-ng/implementations/refuel

Example usage of the getter for the maximum donation share ratio.

```Python
>>> FXSwap.donation_shares_max_ratio()  
100000000000000000          # 10%
```

--------------------------------

### Controller Interaction Examples

Source: https://docs.curve.finance/developer/crvusd/controller

Basic usage examples for borrowing more and checking user state via the Controller interface.

```Python
>>> Controller.borrow_more(10**18, 10**22)  
  
>>> Controller.user_state(trader)  
[2000000000000000000, 0, 11000001592726154783594, 10]  
# [collateral, stablecoin, debt, bands]
```

--------------------------------

### Get future_epoch_time

Source: https://docs.curve.finance/developer/gauges/gauges/liquidity-gauge-v6

Retrieves the future epoch start time from the inflation_params storage.

```Vyper
inflation_params: uint256

@view
@external
def future_epoch_time() -> uint256:
    """
    @notice Get the locally stored CRV future epoch start time
    """
    return self.inflation_params >> 216
```

```Python
>>> LiquidityGaugeV6.future_epoch_time()
1723501048
```

--------------------------------

### Get Total Gauges

Source: https://docs.curve.finance/developer/gauges/gauge-controller

The storage definition for the total gauge count and an example of how to query it.

```vyper
n_gauges: public(int128)
```

```python
>>> GaugeController.n_gauges()
1033
```

--------------------------------

### Dispatch Fees Examples

Source: https://docs.curve.finance/developer/fees/FeeSplitter

Examples showing how to trigger fee collection from all controllers or specific ones.

```Python
>>> FeeSplitter.dispatch_fees()
```

```Python
>>> FeeSplitter.dispatch_fees([  
    "0x8472A9A7632b173c8Cf3a86D3afec50c35548e76",                     # sfrxETH Controller  
    "0x100dAa78fC509Db39Ef7D04DE0c1ABD299f4C6CE"])                    # wstETH Controller
```

--------------------------------

### Retrieve Loan Index

Source: https://docs.curve.finance/developer/llamalend-v2/lend-controller

Example of calling the loan_ix function to get the index of a user's loan.

```javascript
const contract = new Contract('0xc77d97cf01737eb7ace46cab7cd9f60ec51a40c0', LendControllerAbi, signer)  
const tx = await contract.loan_ix(  
  /* _user: address */ "0x0000000000000000000000000000000000000000",  
)  
await tx.wait()  
```

--------------------------------

### Toggle Minting Approval Example

Source: https://docs.curve.finance/developer/gauges/minter

Demonstrates checking and toggling minting permissions for a specific address.

```Python
>>> Minter.allowed_to_mint_for('0x989AEb4d175e16225E39E87d0D97A3360524AD80', '0xF147b8125d2ef93FB6965Db97D6746952a133934')  
False  
  
>>> Minter.toggle_approve_mint('0x989AEb4d175e16225E39E87d0D97A3360524AD80')  
  
>>> Minter.allowed_to_mint_for('0x989AEb4d175e16225E39E87d0D97A3360524AD80', '0xF147b8125d2ef93FB6965Db97D6746952a133934')  
True
```

--------------------------------

### Get Registry by Index

Source: https://docs.curve.finance/developer/integration/meta-registry

Fetches the registry handler address at a specific index. Indices start at 0.

```Vyper
# get registry/registry_handler by index, index starts at 0:  
get_registry: public(HashMap[uint256, address])  
registry_length: public(uint256)
```

```python
>>> MetaRegistry.get_registry(0)
```

--------------------------------

### Method ID Calculation Example

Source: https://docs.curve.finance/developer/amm/factory/stableswap-ng/deployer-api

Shows the correct way to calculate the four-byte Keccak-256 hash for a function signature.

```text
getExchangeRate      ->  "0xb2fc0e3e"           # wrong  
getExchangeRate()    ->  "0xe6aa216c"           # correct  
```

--------------------------------

### Example Constructor Arguments for CRV Market

Source: https://docs.curve.finance/developer/lending/contracts/crypto-from-pool

Example configuration for initializing an oracle contract for a CRV/crvUSD lending market using the TriCRV pool.

```python
# the following arguments will be passed into the `__init__` function:  
pool = '0x4ebdf703948ddcea3b11f675b4d1fba9d2414a14'  
N = 3  
borrow_ix = 0               # crvUSD  
collateral_ix = 2           # CRV
```

--------------------------------

### Get User Voting Power

Source: https://docs.curve.finance/developer/gauges/gauge-controller

Example of fetching the total allocated voting power for a specific user address.

```Python
>>> GaugeController.vote_user_power('0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045')
```

--------------------------------

### Apply New Parameters Usage Example

Source: https://docs.curve.finance/developer/amm/twocrypto-ng/pools/twocrypto

Example of calling the apply_new_parameters function.

```Python
>>> TwoCrypto.apply_new_parameters(20000000, 45000000, 350000000000000, 100000000000, 100000000000, 1800, 1800)
```

--------------------------------

### Get underlying token exchange amount

Source: https://docs.curve.finance/developer/amm/stableswap-ng/pools/metapool

Example usage of the get_dx_underlying function to calculate required input amounts.

```python
>>> StableSwap.get_dx_underlying(0, 1, 10**6)  
998546308572137376  
>>> StableSwap.get_dx_underlying(0, 3, 10**6)  
999171
```

--------------------------------

### Get Virtual Price Implementation and Example

Source: https://docs.curve.finance/developer/amm/stableswap-ng/pools/oracles

Retrieves the current virtual price of the LP token. Note that this method may be vulnerable to donation-style attacks if the pool contains rebasing tokens.

```vyper
@view  
@external  
@nonreentrant('lock')  
def get_virtual_price() -> uint256:  
    """
    @notice The current virtual price of the pool LP token  
    @dev Useful for calculating profits.
        The method may be vulnerable to donation-style attacks if implementation
        contains rebasing tokens. For integrators, caution is advised.
    @return LP token virtual price normalized to 1e18
    """
    amp: uint256 = self._A()
    xp: DynArray[uint256, MAX_COINS] = self._xp_mem(
        self._stored_rates(), self._balances()
    )
    D: uint256 = self.get_D(xp, amp)
    # D is in the units similar to DAI (e.g. converted to precision 1e18)
    # When balanced, D = n * x_u - total virtual value of the portfolio
    return D * PRECISION / self.total_supply
```

```python
>>> StableSwap.get_virtual_price()  
1000063971106330426
```

--------------------------------

### Example usage of deposit_reward_token

Source: https://docs.curve.finance/developer/gauges/gauges/liquidity-gauge-v6

A Python-style example showing how to call the deposit_reward_token function with a token address, amount, and duration.

```python
>>> LiquidityGaugeV6.deposit_reward_token('0xfe18aE03741a5b84e39C295Ac9C856eD7991C38e', 1000000000000000000, 604800)
```

--------------------------------

### User Price Range Example

Source: https://docs.curve.finance/developer/crvusd/controller

Example output showing the liquidation range for a user's loan.

```Python
>>> Controller.users_price(trader):  
[6401870706098817273644, 5789737113118292909562]
```

--------------------------------

### Example User State Output

Source: https://docs.curve.finance/developer/crvusd/controller

Example output of the user_state function call.

```Python
>>> Controller.user_state(trader)  
[2000000000000000000, 0, 11000001592726154783594, 10]
```

--------------------------------

### GET /v1/chains/

Source: https://docs.curve.finance/developer/integration/api/curve-prices

Get all supported chains.

```APIDOC
## GET /v1/chains/

### Description
Get all supported chains.

### Method
GET

### Endpoint
/v1/chains/
```

--------------------------------

### Example usage of calc_fee_token_amount

Source: https://docs.curve.finance/developer/amm/tricrypto-ng/utility-contracts/views

A Python-style console example demonstrating how to call the function with specific input parameters.

```Python
>>> ViewMethodContract.calc_fee_token_amount([1,1,1], 0, "0xf5f5B97624542D72A9E06f04804Bf81baA15e2B4")  
48166379
```

--------------------------------

### Controller Loan Interaction Examples

Source: https://docs.curve.finance/developer/crvusd/controller

Example usage of loan creation and state retrieval methods.

```Python
>>> Controller.create_loan(10**18, 10**21, 10)  
  
>>> Controller.debt(trader)  
1000000000000000000000  
  
>>> Controller.user_state(trader)  
[1000000000000000000, 0, 1000000000000000000000, 10]  
# [collateral, stablecoin, debt, bands]
```

--------------------------------

### Add Liquidity Example

Source: https://docs.curve.finance/developer/amm/tricrypto-ng/pools/tricrypto

Example usage for adding liquidity to the TriCrypto pool.

```Python
>>> TriCrypto.add_liquidity('todo')  
''
```

--------------------------------

### Example Usage of Exchange

Source: https://docs.curve.finance/developer/amm/stableswap-ng/pools/plainpool

Demonstrates how to calculate the expected output amount and execute an exchange.

```python
>>> expected_dy = pool.get_dy(0, 1, 10**18) * 0.99  
>>> StableSwap.exchange(0, 1, 10**18, expected_dy)  
999712
```

--------------------------------

### JavaScript Example for user_prices

Source: https://docs.curve.finance/developer/llamalend-v2/lend-controller-view

Example usage of the user_prices function using ethers.js.

```javascript
const contract = new Contract('0xcda563f85388e621e7d810387e5afdac5d395e2b', LendControllerViewAbi, provider)
const result = await contract.user_prices(
  /* _user: address */ "0x0000000000000000000000000000000000000000",
)
```

--------------------------------

### BurnFrom Example

Source: https://docs.curve.finance/developer/amm/legacy/cryptoswap/lp-tokens/lp-token-v5

Example usage of the burnFrom method.

```Python
>>> LPTokenV5.burnFrom("todo")  
"todo"  
```

--------------------------------

### Deploy Plain Pool Example

Source: https://docs.curve.finance/developer/amm/factory/stableswap-ng/deployer-api

Example usage of the factory contract to deploy a new plain pool.

```python
>>> Factory.deploy_plain_pool(  
    "crvusd/USDT",  # _name  
    "crvusd-usdt",  # _symbol  
    [ # coins:  
        "0xf939E0A03FB07F59A73314E73794Be0E57ac1b4E", # crvusd   
        "0xdAC17F958D2ee523a2206206994597C13D831ec7" # usdt  
    ],  
    1500 # _A  
    1000000, # _fee  
    20000000000, # _offpeg_fee_multiplier  
    865, # _ma_exp_time  
    0, # _implementation_idx  
    [0, 0], # _asset_types  
    [b"", b""], # _method_ids  
    ["0x0000000000000000000000000000000000000000", "0x0000000000000000000000000000000000000000"] # _oracles  
)  
  
'returns address of the deployed plain pool'
```

--------------------------------

### Maximum Rate Usage Example

Source: https://docs.curve.finance/developer/lending/contracts/semilog-mp

Example showing how to query the current maximum rate.

```python
In  [1]:  SemilogMonetaryPolicy.max_rate()  
Out [1]:  15854895991
```

--------------------------------

### Allowance Example

Source: https://docs.curve.finance/developer/amm/legacy/cryptoswap/lp-tokens/lp-token-v5

Example usage of the allowance method.

```Python
>>> LPTokenV5.allowance("todo")  
"todo"  
```

--------------------------------

### LeverageZap Initialization Logic

Source: https://docs.curve.finance/developer/crvusd/leverage/leverage-zap

Contract initialization logic setting up controller, router, and route configurations.

```Vyper
route_params: public(HashMap[uint256, uint256[3][4]])  
  
@external  
def __init__(  
        _controller: address,  
        _collateral: address,  
        _router: address,  
        _routes: DynArray[address[9], 20],  
        _route_params: DynArray[uint256[3][4], 20],  
        _route_pools: DynArray[address[4], 20],  
        _route_names: DynArray[String[64], 20],  
):  
    CONTROLLER = _controller  
    ROUTER = Router(_router)  
  
    amm: address = Controller(_controller).amm()  
    AMM = LLAMMA(amm)  
    _A: uint256 = LLAMMA(amm).A()  
    A = _A  
    Aminus1 = _A - 1  
    LOG2_A_RATIO = self.log2(_A * 10 **18 / unsafe_sub(_A, 1))  
    SQRT_BAND_RATIO = isqrt(unsafe_div(10 **36 * _A, unsafe_sub(_A, 1)))  
    COLLATERAL_PRECISION = pow_mod256(10, 18 - ERC20(_collateral).decimals())  
  
    for i in range(20):  
        if i >= len(_routes):  
            break  
        self.routes[i] = _routes[i]  
        self.route_params[i] = _route_params[i]  
        self.route_pools[i] = _route_pools[i]  
        self.route_names[i] = _route_names[i]  
    self.routes_count = len(_routes)  
  
    ERC20(CRVUSD).approve(_router, max_value(uint256), default_return_value=True)  
    ERC20(_collateral).approve(_controller, max_value(uint256), default_return_value=True)  
```

--------------------------------

### GET /v1/lending/markets

Source: https://docs.curve.finance/developer/integration/api/curve-prices

Get information on all lending markets.

```APIDOC
## GET /v1/lending/markets

### Description
Get information on all lending markets.

### Method
GET

### Endpoint
/v1/lending/markets
```

--------------------------------

### Example usage of get_y

Source: https://docs.curve.finance/developer/amm/stableswap-ng/utility-contracts/math

A placeholder example demonstrating how to call the get_y function.

```Python
>>> Math.get_y('todo')  
'todo'
```

--------------------------------

### Deploy a RootGauge

Source: https://docs.curve.finance/developer/gauges/xchain-gauges/root-gauge-factory

Example of deploying a RootGauge for a specific chain ID.

```python
>>> RootGaugeFactory.deploy_gauge(252, '0x0000000000000000000000000000000000000000000000000000000000000000')
```

--------------------------------

### GET /v1/dao/fees/distributions

Source: https://docs.curve.finance/developer/integration/api/curve-prices

Get historical fee distributions.

```APIDOC
## GET /v1/dao/fees/distributions

### Description
Get historical fee distributions.

### Method
GET

### Endpoint
/v1/dao/fees/distributions
```

--------------------------------

### GET /v1/dao/gauges/overview

Source: https://docs.curve.finance/developer/integration/api/curve-prices

Get descriptive metadata for all gauges.

```APIDOC
## GET /v1/dao/gauges/overview

### Description
Get descriptive metadata for all gauges.

### Method
GET

### Endpoint
/v1/dao/gauges/overview
```

--------------------------------

### Dynamic Fee Usage Example

Source: https://docs.curve.finance/developer/amm/stableswap-ng/utility-contracts/views

A placeholder example demonstrating how to call the dynamic_fee function.

```Python
>>> StableSwap.dynamic_fee('todo')  
'todo'
```

--------------------------------

### Import DAO Parameters

Source: https://docs.curve.finance/developer/curve-dao/governance/voting-library

Importing the predefined OWNERSHIP and PARAMETER DAO configurations.

```python
from voting import OWNERSHIP, PARAMETER  
  
# OWNERSHIP  
# agent:  0x40907540d8a6C65c637785e8f8B742ae6b0b9968  
# voting: 0xE478de485ad2fe566d49342Cbd03E49ed7DB3356  
# token:  0x5f3b5DfEb7B28CDbD7FAba78963EE202a494e2A2  
# quorum: 30  
  
# PARAMETER  
# agent:  0x4eeb3ba4f221ca16ed4a0cc7254e2e32df948c5f  
# voting: 0xbcff8b0b9419b9a88c44546519b1e909cf330399  
# token:  0x5f3b5DfEb7B28CDbD7FAba78963EE202a494e2A2  
# quorum: 15  
```

--------------------------------

### GET /v1/crvusd/savings/statistics

Source: https://docs.curve.finance/developer/integration/api/curve-prices

Get current statistics of scrvUSD.

```APIDOC
## GET /v1/crvusd/savings/statistics

### Description
Get current statistics of scrvUSD.

### Method
GET

### Endpoint
/v1/crvusd/savings/statistics
```

--------------------------------

### GET /v1/crvusd/markets

Source: https://docs.curve.finance/developer/integration/api/curve-prices

Get information on all crvUSD markets.

```APIDOC
## GET /v1/crvusd/markets

### Description
Get information on all crvUSD markets.

### Method
GET

### Endpoint
/v1/crvusd/markets
```

--------------------------------

### Example: Query Total Market Debt

Source: https://docs.curve.finance/developer/crvusd/controller

Example usage of the total_debt method to retrieve the market's total debt.

```Python
>>> Controller.total_debt()  
4047221089417662821708552
```

--------------------------------

### Renouncing Ownership Example

Source: https://docs.curve.finance/developer/fees/FeeSplitter

Demonstrates the state change of the owner address after calling renounce_ownership.

```python
>>> FeeSplitter.owner()  
"0x40907540d8a6C65c637785e8f8B742ae6b0b9968"  
  
>>> FeeSplitter.renounce_ownership()  
  
>>> FeeSplitter.owner()  
"0x0000000000000000000000000000000000000000"  
```

--------------------------------

### Update Price Example

Source: https://docs.curve.finance/developer/scrvusd/crosschain/oracle-v2/oracle

Example usage of the update_price function.

```python
>>> ScrvusdOracleV2.update_price()
```

--------------------------------

### Create Loan Implementation

Source: https://docs.curve.finance/developer/crvusd/controller

The create_loan function initializes a user's loan position, validates band constraints, and interacts with the AMM to deposit collateral.

```Vyper
event UserState:  
    user: indexed(address)  
    collateral: uint256  
    debt: uint256  
    n1: int256  
    n2: int256  
    liquidation_discount: uint256  
  
event Borrow:  
    user: indexed(address)  
    collateral_increase: uint256  
    loan_increase: uint256  
  
MAX_TICKS: constant(int256) = 50  
MIN_TICKS: constant(int256) = 4  
  
@external  
@nonreentrant('lock')  
def create_loan(collateral: uint256, debt: uint256, N: uint256):  
    """  
    @notice Create loan  
    @param collateral Amount of collateral to use  
    @param debt Stablecoin debt to take  
    @param N Number of bands to deposit into (to do autoliquidation-deliquidation),  
        can be from MIN_TICKS to MAX_TICKS  
    """  
    self._create_loan(collateral, debt, N, True)  
  
@internal  
def _create_loan(collateral: uint256, debt: uint256, N: uint256, transfer_coins: bool):  
    assert self.loan[msg.sender].initial_debt == 0, "Loan already created"  
    assert N > MIN_TICKS-1, "Need more ticks"  
    assert N < MAX_TICKS+1, "Need less ticks"  
  
    n1: int256 = self._calculate_debt_n1(collateral, debt, N)  
    n2: int256 = n1 + convert(N - 1, int256)  
  
    rate_mul: uint256 = AMM.get_rate_mul()  
    self.loan[msg.sender] = Loan({initial_debt: debt, rate_mul: rate_mul})  
    liquidation_discount: uint256 = self.liquidation_discount  
    self.liquidation_discounts[msg.sender] = liquidation_discount  
  
    n_loans: uint256 = self.n_loans  
    self.loans[n_loans] = msg.sender  
    self.loan_ix[msg.sender] = n_loans  
    self.n_loans = unsafe_add(n_loans, 1)  
  
    self._total_debt.initial_debt = self._total_debt.initial_debt * rate_mul / self._total_debt.rate_mul + debt  
    self._total_debt.rate_mul = rate_mul  
  
    AMM.deposit_range(msg.sender, collateral, n1, n2)  
    self.minted += debt  
  
    if transfer_coins:  
        self.transferFrom(COLLATERAL_TOKEN, msg.sender, AMM.address, collateral)  
        self.transfer(BORROWED_TOKEN, msg.sender, debt)  
  
self._save_rate()  
  
log UserState(msg.sender, collateral, debt, n1, n2, liquidation_discount)  
log Borrow(msg.sender, collateral, debt)
```

--------------------------------

### Max Redeem Example

Source: https://docs.curve.finance/developer/lending/contracts/vault

Example usage of the maxRedeem function.

```Python
>>> Vault.maxRedeem("0x7a16fF8270133F063aAb6C9977183D9e72835428")  
45836614069469292514157944
```

--------------------------------

### Example usage of set_default_rates

Source: https://docs.curve.finance/developer/lending/contracts/oneway-factory

Interactive console example showing how to query and update the default borrow rates.

```python
In  [1]:  OneWayLendingVaultFactory.min_default_borrow_rate()  
Out [1]:  158548959  
  
In  [2]:  OneWayLendingVaultFactory.max_default_borrow_rate()  
Out [2]:  15854895991  
  
In  [3]:  OneWayLendingVaultFactory.set_default_rates(168548959, 16854895991)  
  
In  [4]:  OneWayLendingVaultFactory.min_default_borrow_rate()  
Out [4]:  168548959  
  
In  [5]:  OneWayLendingVaultFactory.max_default_borrow_rate()  
Out [5]:  16854895991
```

--------------------------------

### FeeSplitter Initialization and Ownership Setup

Source: https://docs.curve.finance/developer/fees/FeeSplitter

Constructor implementation for FeeSplitter, demonstrating the initialization of the ownable module and setting the initial owner.

```vyper
from snekmate.auth import ownable  
initializes: ownable  
exports: (  
    ownable.transfer_ownership,  
    ownable.renounce_ownership,  
    ownable.owner  
)  
  
@deploy  
def __init__(  
    _crvusd: IERC20,  
    _factory: multiclaim.IControllerFactory,  
    receivers: DynArray[Receiver, MAX_RECEIVERS],  
    owner: address,  
):  
    """  
    @notice Contract constructor  
    @param _crvusd The address of the crvUSD token contract  
    @param _factory The address of the crvUSD controller factory  
    @param receivers The list of receivers (address, weight).  
        Last item in the list is the excess receiver by default.  
    @param owner The address of the contract owner  
    """  
    assert _crvusd.address != empty(address), "zeroaddr: crvusd"  
    assert owner != empty(address), "zeroaddr: owner"  
  
    ownable.__init__()  
    ownable._transfer_ownership(owner)  
    multiclaim.__init__(_factory)  
  
    # setting immutables  
    crvusd = _crvusd  
  
    # set the receivers  
    self._set_receivers(receivers)  
```

--------------------------------

### Example Usage of deploy_gauge

Source: https://docs.curve.finance/developer/gauges/gauges/gauge-factory

A practical example showing how to call the deploy_gauge function with an LP token address.

```python
# Example: Deploying a gauge for a specific LP token  
>>> GaugeFactory.deploy_gauge("0x2791Bca1f2de4661ED88A30C99A7a9449Aa84174")  
'0x729227A6a88bE1D3478d10C240E10d65E785412e'
```

--------------------------------

### Commit BlockHash Example

Source: https://docs.curve.finance/developer/scrvusd/crosschain/oracle-v0

Example usage of the commit function.

```Python
>>> BlockHashOracle.commit()
```

--------------------------------

### Example of updating profit_max_unlock_time

Source: https://docs.curve.finance/developer/scrvusd/crosschain/oracle-v2/oracle

Demonstrates the sequence of checking and updating the profit_max_unlock_time parameter.

```python
>>> ScrvusdOracleV2.profit_max_unlock_time()  
604800  
  
>>> ScrvusdOracleV2.update_profit_max_unlock_time(302400, todo)  
  
>>> ScrvusdOracleV2.profit_max_unlock_time()  
302400  
```

--------------------------------

### Inflation Rate Example

Source: https://docs.curve.finance/developer/gauges/xchain-gauges/child-gauge

Example usage of the inflation_rate getter.

```Python
>>> ChildGauge.inflation_rate(1)  
0  
```

--------------------------------

### Set Distribution Time Usage Example

Source: https://docs.curve.finance/developer/scrvusd/rewards-handler

Example demonstrating how to update the distribution time via the RewardsHandler interface.

```python
>>> RewardsHandler.distribution_time()  
604800  
  
>>> RewardsHandler.set_distribution_time(302400)  
  
>>> RewardsHandler.distribution_time()  
302400  
```

--------------------------------

### Claimable Tokens Example

Source: https://docs.curve.finance/developer/gauges/xchain-gauges/child-gauge

Example usage of the claimable_tokens function.

```Python
>>> ChildGauge.claimable_tokens('0x20a440aECf78c73d484B652C46d582B4D70906A8')  
0  
```

--------------------------------

### Integrate Fraction Example

Source: https://docs.curve.finance/developer/gauges/xchain-gauges/child-gauge

Example usage of the integrate_fraction getter.

```Python
>>> ChildGauge.integrate_fraction('0x20a440aECf78c73d484B652C46d582B4D70906A8')  
0  
```

--------------------------------

### Admin Fees Example

Source: https://docs.curve.finance/developer/crvusd/controller

Example usage of the admin_fees function.

```Python
>>> Controller.admin_fees()  
1431079351921267396706  
```

--------------------------------

### Set Reward Distributor Usage Example

Source: https://docs.curve.finance/developer/gauges/xchain-gauges/child-gauge

Example showing how to check the current distributor and update it using the set_reward_distributor method.

```python
>>> ChildGauge.reward_data('0x498Bf2B1e120FeD3ad3D42EA2165E9b73f99C1e5')  
{  
    'distributor': '0x1234567890123456789012345678901234567890',  
    'rate': 0,  
    'last_update': 0,  
    'period_finish': 0,  
    'integral': 0  
}  
  
>>> ChildGauge.set_reward_distributor('0x498Bf2B1e120FeD3ad3D42EA2165E9b73f99C1e5', '0x9876543210987654321098765432109876543210')  
  
>>> ChildGauge.reward_data('0x498Bf2B1e120FeD3ad3D42EA2165E9b73f99C1e5')  
{  
    'distributor': '0x9876543210987654321098765432109876543210',  
    'rate': 0,  
    'last_update': 0,  
    'period_finish': 0,  
    'integral': 0  
}
```

--------------------------------

### Example: Query User Debt

Source: https://docs.curve.finance/developer/crvusd/controller

Example usage of the debt method to retrieve a specific user's debt balance.

```Python
>>> Controller.debt(trader)  
11000001592726154783594
```

--------------------------------

### Rate Multiplier Example

Source: https://docs.curve.finance/developer/crvusd/amm

Example output for the get_rate_mul function.

```Python
>>> AMM.get_rate_mul()  
1100902413540693190  
```
Tokens:
Raw