# @lyrafinance/core > core smart contracts for lyra option markets Latest version **0.1.8-test** (published 2022-05-05) · ISC license · 0 weekly downloads > **Deprecated.** This package is deprecated. ## Install ```sh npm install @lyrafinance/core pnpm add @lyrafinance/core yarn add @lyrafinance/core bun add @lyrafinance/core ``` ## Health **Score 10/100 (F)** — status: deprecated. Negative: deprecated. ## Facts | | | |---|---| | Version | 0.1.8-test | | Published | 2022-05-05 | | First published | 2022-04-05 | | Weekly downloads | 0 | | License | ISC | | TypeScript types | bundled | | Module format | CommonJS | | Dependencies | 9 | | Unpacked size | 6.2 MB | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 103 | | Author | Lyra Finance | | Maintainers | 0xvac, rokueth, jakefitz, josh.pwrk | ## Links - npm: https://www.npmjs.com/package/@lyrafinance/core - Repository: https://github.com/lyra-finance/lyra-protocol/tree/avalon - Homepage: http://www.lyra.finance - npm.io page: https://npm.io/package/@lyrafinance/core ## Dependencies (9) - [lodash](https://npm.io/package/lodash.md) ^4.17.21 - [stochastic](https://npm.io/package/stochastic.md) ^0.0.14 - [@types/lodash](https://npm.io/package/@types/lodash.md) ^4.14.180 - [hardhat-tracer](https://npm.io/package/hardhat-tracer.md) 1.0.0-alpha.6 - [@ethersproject/abi](https://npm.io/package/@ethersproject/abi.md) ^5.4.0 - [@ethersproject/web](https://npm.io/package/@ethersproject/web.md) ^5.6.0 - [@openzeppelin/contracts](https://npm.io/package/@openzeppelin/contracts.md) ^4.4.1 - [@openzeppelin/hardhat-upgrades](https://npm.io/package/@openzeppelin/hardhat-upgrades.md) ^1.14.0 - [@openzeppelin/contracts-upgradeable](https://npm.io/package/@openzeppelin/contracts-upgradeable.md) ^4.5.1 ## Recent versions - 0.1.8-test (latest) — 2022-05-05 - 0.1.7-test — 2022-05-05 - 0.1.6-test — 2022-05-05 - 0.1.5-test — 2022-05-05 - 0.1.4-test — 2022-05-05 - 0.1.3-test — 2022-05-05 - 0.1.2-alpha — 2022-05-05 - 0.1.1-alpha — 2022-04-06 - 0.1.0-alpha — 2022-04-05 ## README # DEPRECATED - use @lyrafinance/protocol # Lyra - Smart Contracts [![CI](https://github.com/lyra-finance/lyra/actions/workflows/run-test.yml/badge.svg)](https://github.com/lyra-finance/lyra/actions/workflows/run-test.yml) [![codecov](https://codecov.io/gh/lyra-finance/lyra/branch/master/graph/badge.svg?token=PQZNKHH63H)](https://codecov.io/gh/lyra-finance/lyra) ## Documentation Avalon documentation coming soon! [Pre-Avalon Docs](https://docs.lyra.finance/implementation/protocol-architecture) ## Installation ```bash $ yarn add @lyrafinance/protocol ``` ## Importing Lyra contracts ```solidity import {VaultAdapter} from '@lyrafinance/protocol/contracts/periphery/VaultAdapter.sol'; contract DeltaStrategy is VaultAdapter { // your structured product contract } ``` Refer to the [Lyra vaults example project](https://github.com/lyra-finance/lyra-vaults/blob/master/contracts/strategies/DeltaStrategy.sol) on using the `VaultsAdapter` to connect your vault to Lyra. ## Deploy a Lyra market in hardhat test ```typescript import { TestSystem } from '@lyrafinance/protocol' describe('Integration Test', () => { before(async () => { let testSystem = await TestSystem.deploy(signer); await TestSystem.seed(signer, testSystem); }); it('your integration test', async () => { ... }); }); ``` ## Integrate with Lyra in hardhat test ```typescript it('will pay out long calls', async () => { boardIds = await testSystem.optionMarket.getLiveBoards(); strikeIds = await testSystem.optionMarket.getBoardStrikes(boardIds[0]); // Buy long call await testSystem.optionMarket.openPosition( { strikeId: strikeIds[0], positionId: 0, amount: toBN('1'), setCollateralTo: 0, iterations: 1, minTotalCost: 0, maxTotalCost: MAX_UINT, optionType: TestSystem.OptionType.LONG_CALL }); // Wait till board expires await fastForward(MONTH_SEC); // Mock sETH price await TestSystem.mockPrice(testSystem, toBN("1500"), 'sETH'); // Settle option and confirm payout await testSystem.optionMarket.settleExpiredBoard(boardIds[0]); const preBalance = await testSystem.snx.quoteAsset.balanceOf(signer.address); await testSystem.shortCollateral.settleOptions([strikeIds[0]]); const postBalance = await testSystem.snx.quoteAsset.balanceOf(signer.address); expect(postBalance.sub(preBalance)).to.eq(toBN('500')); }); ``` Refer to the [Lyra vaults example project](https://github.com/lyra-finance/lyra-vaults/tree/master/test/integration-tests) on hardhat testing against a mock Lyra market. ## Calling Lyra on kovan-ovm/mainnet-ovm ```typescript import { getMarketDeploys, getGlobalDeploys } from '@lyrafinance/protocol'; // get lyra address/abi/bytecode/more let lyraMarket = getMarketDeploys('kovan-ovm', 'sETH'); let lyraGlobal = getGlobalDeploys('kovan-ovm'); const testFaucet = new Contract(lyraGlobal.TestFaucet.address, lyraGlobal.TestFaucet.abi, deployer); const sUSD = new Contract(lyraGlobal.QuoteAsset.address, lyraGlobal.QuoteAsset.abi, deployer); const optionMarket = new Contract(lyraMarket.OptionMarket.address, lyraMarket.OptionMarket.abi, deployer); // call lyra (`execute` is any implementation of a contract call) await execute(testFaucet, 'drip', [] as any, provider); await execute(sUSD, 'approve', [optionMarket.address, MAX_UINT], provider); await execute(optionMarket, 'openPosition', [tradeParams], provider); ``` Refer to the [Lyra vaults example project](https://github.com/lyra-finance/lyra-vaults/tree/master/scripts) for calling kovan/main-net Lyra markets. ## Deploy Lyra locally ```typescript // deployLyraExample.ts import { TestSystem } from '@lyrafinance/protocol'; async function main() { // 1. create local deployer and network const provider = new ethers.providers.JsonRpcProvider('http://localhost:8545'); const privateKey = 'local eth address with ETH'; // 2. optional settings to prevent errors provider.getGasPrice = async () => { return ethers.BigNumber.from('0'); }; provider.estimateGas = async () => { return ethers.BigNumber.from(15000000); } const deployer = new ethers.Wallet(privateKey, provider); // 3. deploy and seed Lyra market let linkTracer = false; let exportAddresses = true; let localTestSystem = await TestSystem.deploy(deployer, linkTracer, exportAddresses); await TestSystem.seed(deployer, localTestSystem, overrides={}); // 4. call local contracts await localTestSystem.optionMarket.openPosition({ strikeId: 1; positionId: 0; optionType: TestSystem.OptionType.LONG_CALL; amount: toBN("1"); setCollateralTo: toBN("0"); iterations: 3; minTotalCost: toBN("0"); maxTotalCost?: toBN("250"); };) ``` ```bash $ yarn hardhat node $ yarn hardhat run deployLyraExample.ts // in a separate window ``` > Can also use `getGlobal/MarketDeploys` on local network by setting `exportAddresses=true` Refer to the [Lyra vaults example project](https://github.com/lyra-finance/lyra-vaults/tree/master/scripts) for creating a local Lyra market. ## Advanced For overriding specific parameters when using `TestSystem.deploy()` or `TestSystem.seed()` ```typescript const overrides: DeployOverrides = { optionMarketParams: { ...lyraCore.defaultParams.optionMarketPerams, feePortionReserved: toBN('0.05') } } ``` For easy debugging, set `linkTracer = true` to use `hardhat-tracer` to display all emitted events for every hardhat contract call (does not work in local/kovan/main-net yet) ```typescript let linkTracer=true; let localTestSystem = await deployTestSystem(deployer, linkTracer); ``` Run your test scripts with the `yarn test --logs` to enable the plug-in. ## Useful calls / common errors [WIP] For local/hardhat: - `testSystem.optionGreekCache(baordId)` to prevent stale board reverts - `testSystem.optionMarket.settleBoard(boardId)` before settling individual positions - `testSystem.mockPrice()` to set mock prices - `lyraEvm.fastForward(jumpTime)`to jump to expiry/fast-forward - use `DeployOverride` and `SeedOverride` during `testSystem.deploy/seed` for setting custom market params such as `standardSize`, `minDelta` and etc. --- _Source: https://npm.io/package/@lyrafinance/core · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._