A Jupyter Notebook environment for Keep3r E2E testing.
Artifacts:
- Keep3rV2
- Keep3r Liquidity Pool Manager
- Keep3rV1Proxy
- Job for Test
Notebooks:
00-setup
: A common setup for Keep3r environment deployment01-credit-mining
: Time based credit mining (Tokenomics)02-job-migration
: Feature to migrate assets and liquidities to a new job03-version-comparison
: A comparison between both versions with the same job
- Execute
yarn install
- Execute
yarn jupyter:install
- Execute
yarn jupyter
- Open
http://localhost:8888/
if not automatically redirected - Select
Node.js
as kernel to run all00-setup.ipynb
- Open another notebook and select:
Navigation bar > Kernel > Change kernel... > 00-setup.ipynb
- Re-run
00-setup.ipynb
to restart the environment - Execute
yarn jupyter:kill
to terminate the Jupyter environment
fetch(abi, address)
: gets contract at addressdeploy(abi, parameters)
: deploys contractaddViewTrace(contract, viewName, viewArgument, traceName)
: registers a view result to be recordedaddEventTrace(contract, eventName, timestampIndexArgument)
: registers an event log to be recorded- TODO:
addScriptTrace()
sleep(time)
: advances timesleepAndRecord(timeToSleep, recordEvery)
: advances time and records tracessleepAndExecute(timeToSleep, recordEvery, [{run, every}])
: advances time and records traces while executing a function
keep3r.v2
: release candidate of Keep3rV2keep3r.v1
: used for ERC20 implementationkeep3r.helper
: implementation ofKeep3rHelper
keep3r.pool
: implementation ofUniV3PairManager
that tokenizes aUniswapV3
KP3R/WETH 1% fee liquidity positionkeep3r.keeper
: registered and bondedkeeper
keep3r.governance
: governance ofKeep3rProxy
keep3r.proxy
: governance ofKeep3rV1
andKeep3rV2