diff --git a/.github/workflows/build-dev.yml b/.github/workflows/build-dev.yml deleted file mode 100644 index 93b93c3..0000000 --- a/.github/workflows/build-dev.yml +++ /dev/null @@ -1,38 +0,0 @@ -name: Create dev build - -on: - push: - branches: - - main - # Review gh actions docs if you want to further define triggers, paths, etc - # https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#on - -permissions: - contents: write - -jobs: - create: - name: Create dev build - runs-on: ubuntu-latest - env: - BRANCH: dev - steps: - - uses: actions/checkout@v3 - - uses: actions/setup-node@v3 - with: - node-version: 18 - cache: npm - - - name: Install dependencies - run: npm ci - - name: Build website - run: npm run build - - - name: Push - uses: s0/git-publish-subdir-action@develop - env: - REPO: self - BRANCH: build-dev # The branch name where you want to push the assets - FOLDER: build # The directory where your assets are generated - GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # GitHub will automatically add this - you don't need to bother getting a token - MESSAGE: "Build: ({sha}) {msg}" # The commit message diff --git a/.github/workflows/build-release.yml b/.github/workflows/build-release.yml deleted file mode 100644 index 0189eb8..0000000 --- a/.github/workflows/build-release.yml +++ /dev/null @@ -1,41 +0,0 @@ -name: Create release build - -on: - workflow_dispatch: - inputs: - logLevel: - description: 'Log level' - tags: - description: 'Test scenario tags' - environment: - description: 'Environment to run tests against' - -permissions: - contents: write - -jobs: - create: - name: Create release build - runs-on: ubuntu-latest - env: - BRANCH: main - steps: - - uses: actions/checkout@v3 - - uses: actions/setup-node@v3 - with: - node-version: 18 - cache: npm - - - name: Install dependencies - run: npm ci - - name: Build website - run: npm run build - - - name: Push - uses: s0/git-publish-subdir-action@develop - env: - REPO: self - BRANCH: build-release # The branch name where you want to push the assets - FOLDER: build # The directory where your assets are generated - GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # GitHub will automatically add this - you don't need to bother getting a token - MESSAGE: "Build: ({sha}) {msg}" # The commit message diff --git a/.github/workflows/test-deploy.yml b/.github/workflows/test-deploy.yml deleted file mode 100644 index 8243ec9..0000000 --- a/.github/workflows/test-deploy.yml +++ /dev/null @@ -1,24 +0,0 @@ -name: Test deployment - -on: - pull_request: - branches: - - main - # Review gh actions docs if you want to further define triggers, paths, etc - # https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#on - -jobs: - test-deploy: - name: Test deployment - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v3 - - uses: actions/setup-node@v3 - with: - node-version: 18 - cache: npm - - - name: Install dependencies - run: npm ci - - name: Test build website - run: npm run build \ No newline at end of file diff --git a/README.md b/README.md index adcf792..1fde2f3 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,18 @@ -## AWS Amplify -[https://us-east-1.console.aws.amazon.com/amplify/home?region=us-east-1#/dg68s1zz5zfuo](https://us-east-1.console.aws.amazon.com/amplify/home?region=us-east-1#/dg68s1zz5zfuo) +```mermaid +flowchart TD + main[main] + release[🔒release] + main_website[/dojo.compasslabs.ai/] + dev_website[/dev.dojo.compasslabs.ai/] + developer((Developer)) + feature_branches[feature_branches] + main --> dev_website + release --> main_website -## Deployments + main --> |merge into| release + feature_branches --> |merge into| main -### Dev -[https://build-dev.dg68s1zz5zfuo.amplifyapp.com](https://build-dev.dg68s1zz5zfuo.amplifyapp.com). -This release is updated every time there is a push to main. - - -### Release -[https://dojo.compasslabs.ai/](https://dojo.compasslabs.ai/). -This is the user-facing release. -It is only updated if you manually create a new code release on GitHub + developer --> |push| feature_branches + developer --> |push| main +```` diff --git a/blog/2023-05-25-launch.md b/blog/2023-05-25-launch.md deleted file mode 100644 index 1af5f1a..0000000 --- a/blog/2023-05-25-launch.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -slug: dojo-launch -title: Introducing Dojo! -authors: [elisabeth, rohan] -tags: [dojo, launch] -image: https://raw.githubusercontent.com/CompassLabs/docs/main/static/img/article_env.png ---- - - -Today we are happy to launch dojo: an end-to-end DeFi research platform, enabling **testing**, **training** and **optimizing** DeFi strategies and smart contracts at the EVM smart contract level. Accessible as a Python interface on your local infrastructure. Designed to scale research and productionisation of DeFi strategies! - - - -* **Data Sourcing:** Utilize dojo's on- and off-chain data capabilities for data ingestion and strategy evaluation - -* **Simulation:** Test, train and optimize DeFi strategies and smart contracts through dojo's agent-based simulator to simulate transactions at the EVM smart contract level - -* **Analysis:** Gain insights into strategy performance through tailored agent metric tracking implementation - -# How it works - -Our platform implements an **agent-environment loop** that combines principles from reinforcement learning and agent-based modelling for ultra-realistic and risk-free visibility into smart contract interactions and flow of funds. This flexible framework enables you to **simulate**, **train** and **optimize** a diverse range of scenarios that reflect DeFi dynamics at the **smart contract level**. - -![Agent-environment loop](https://raw.githubusercontent.com/CompassLabs/docs/main/static/img/article_env.png) - -# Benefits - -* **Decrease the sim2real gap:** Dojo runs at the smart contract level and forks the actual blockchain to guarantee on-chain protocol logic - -* **Implement customized strategies:** Dojo’s flexible pythonic interface enables users to implement custom-made policies for agents to adopt - -* **Run on local infrastructure:** Rest assured your strategies and experimentation are kept solely on your local infrastructure - -# Future plans -Today, dojo is in beta testing. Short term, we are developing the following features: - -* **Market impact models:** explore complex scenarios and understand effects of market dynamics on your strategy through inclusion of comprehensive market impact models - -* **MEV models:** simulate block inclusion probability and transaction ordering and gain insight into the implications of MEV - -* **Multi-protocol and multi-chain simulations:** conduct simulations across multiple protocols and chains simultaneously - -Driven by a team of engineers and academics working at the forefront of machine learning and decentralized finance, our long-term vision for Dojo is to become a robust DeFi research and optimization platform for all kinds of applications. Our goal is to provide the much-needed reliability to help investors and DeFi markets to flourish. - -_Dojo is derived from the Japanese words representing immersive learning, and we believe that our solution captures the essence of this concept._ - -# Learn more? - -- Test your strategy, visit [dojo documentation & tutorial](https://dojo.compasslabs.ai/) -- [Reach out](mailto:elisabeth@compasslabs.ai) or beta testing or protocol integration -- Follow Compass Labs on [twitter](https://twitter.com/labs_compass) -- Visit our [website](https://compasslabs.ai/) and request a demo -- Read our [research papers](https://arxiv.org/abs/2301.06831v1) - - diff --git a/blog/authors.yml b/blog/authors.yml deleted file mode 100644 index 05f2f9b..0000000 --- a/blog/authors.yml +++ /dev/null @@ -1,12 +0,0 @@ -rohan: - name: Rohan Tangri - title: CTO @ Compass Labs - url: https://www.linkedin.com/in/rohan-tangri/ - image_url: /img/rohan.jpeg - -elisabeth: - name: Elisabeth Duijnstee - title: CEO @ Compass Labs - url: https://www.linkedin.com/in/elisabeth-duijnstee-9104b7124/ - image_url: /img/elisabeth.jpeg - diff --git a/blog/v1.5 launch.md b/blog/v1.5 launch.md deleted file mode 100644 index 7abc714..0000000 --- a/blog/v1.5 launch.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -slug: dojo v1.5-launch -title: Releasing Dojo v1.5! -tags: [dojo, launch, features, simulation, dashboard, dataloaders] -image: https://raw.githubusercontent.com/CompassLabs/docs/main/static/img/dojov1.52.png ---- - - -We are thrilled to announce the release of [Dojo v1.5](https://dojo.compasslabs.ai/)! -Dojo is an end-to-end DeFi research platform designed to **test**, **train**, and **optimize** of DeFi strategies and smart contracts at the **EVM smart contract level**. Dojo is accessible as a Python interface on your local infrastructure. With this new version, we introduce exciting features and resolved bugs to provide an even more robust and user-friendly experience. Let's dive into the details of the latest updates: - -![Dojo v1.5](https://raw.githubusercontent.com/CompassLabs/docs/main/static/img/dojov1.52.png) - - -* **Visualisation:** Real-Time Simulation Insights - -One of the standout features of dojo v1.5 is the **interactive simulation dashboard**. Now, users can visualize their simulation runs, monitor performance metrics, track agent actions, and stay updated on real-time simulation progress. - -* **Flexible Data Loaders:** Adaptability for Any Environment - -Dojo includes pre-implemented data loaders for integrated protocols, but we understand that users may want to run simulations on environments for which dojo does not have native data support. In response to this, dojo v1.5 introduces **flexible data loaders**. Users can now implement their own data loaders to read in protocol events data specific to their desired environment. Dojo ensures data integrity by performing checks to validate the format and type of the provided data. - -In addition to the new features, our development team has dedicated effort to resolving bugs in the previous version of dojo to enhance the stability of the platform. - -# Want to learn more? - -- Test your strategy, visit [dojo documentation & tutorial](https://dojo.compasslabs.ai/) -- [Reach out](mailto:elisabeth@compasslabs.ai) for beta testing or protocol integration -- Read our [blogs](https://dojo.compasslabs.ai/blog) -- Follow Compass Labs on [twitter](https://twitter.com/labs_compass) -- Visit our [website](https://compasslabs.ai/) and request a demo -- Read our [research papers](https://arxiv.org/abs/2301.06831v1) & [medium articles](https://medium.com/@compasslabs) - diff --git a/docs/1_intro.md b/docs/1_intro.md index 17d8286..3bc4ab4 100644 --- a/docs/1_intro.md +++ b/docs/1_intro.md @@ -19,22 +19,22 @@ sidebar_position: 1 ## Features -### Runs at smart-contract level +### Runs at smart-contract level - `dojo` forks the actual blockchain and runs on the same smart contracts that would be run in real life. - This eliminates concerns about bugs in the model or missed assumptions about the protocol, and enables capturing micro-effects that impact simulation results, such as precision and rounding. -### Runs locally on your machine +### Runs locally on your machine - `dojo` operates fully on your local machine. - There is no sharing of information about your strategies or simulations with us or any other party. -### Simple Python interface +### Simple Python interface - `dojo's` interface allows full experimentation with strategies using Python. - Take advantage of Python's rich ecosystem of tools for data analysis and visualisation. -### Transaction ordering +### Transaction ordering - Directly edit the order of transaction execution for simulating various MEV scenarios. -### Custom data integration +### Custom data integration - `dojo` sources it's own protocol events data for a subset of environments. - For environments we don't natively support, you can load in your existing datasets. @@ -53,7 +53,8 @@ Transfer your strategy from the Dojo fork to mainnet without any modifications, ___ ## ⬇️ Protocol integrations -`dojo` currently integrates with **UniswapV3** on **Ethereum**. We are soon integrating AAVE and are enabling simulation on Polygon and Arbitrum. +`dojo` currently integrates with **UniswapV3** and **AAVEv3** on **Ethereum**. + If you want your chain or protocol to be integrated with `dojo`, [reach out](mailto:elisabeth@compasslabs.ai)! diff --git a/docs/4_environments/_category_.json b/docs/4_environments/_category_.json index f69e075..81773f0 100644 --- a/docs/4_environments/_category_.json +++ b/docs/4_environments/_category_.json @@ -3,6 +3,6 @@ "position": 4, "link": { "type": "generated-index", - "description": "A guide to the `dojo` environments." + "description": "Environments in dojo are representations of different DeFi protocols agents can interact with." } } diff --git a/docusaurus.config.js b/docusaurus.config.js index 0586964..3ae7281 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -72,13 +72,13 @@ const config = { remarkPlugins: [math], rehypePlugins: [katex], }, - blog: { - showReadingTime: true, - // Please change this to your repo. - // Remove this to remove the "edit this page" links. - editUrl: - 'https://github.com/CompassLabs/docs/tree/main/blog', - }, + // blog: { + // showReadingTime: true, + // // Please change this to your repo. + // // Remove this to remove the "edit this page" links. + // editUrl: + // 'https://github.com/CompassLabs/docs/tree/main/blog', + // }, theme: { customCss: require.resolve('./src/css/custom.css'), }, @@ -121,7 +121,7 @@ const config = { position: 'left', label: 'Tutorial', }, - { to: '/blog', label: 'Blog', position: 'left' }, + // { to: '/blog', label: 'Blog', position: 'left' }, { href: 'https://github.com/CompassLabs', label: 'GitHub', @@ -173,10 +173,10 @@ const config = { { title: 'More', items: [ - { - label: 'Blog', - to: '/blog', - }, + // { + // label: 'Blog', + // to: '/blog', + // }, { label: 'GitHub', href: 'https://github.com/CompassLabs', diff --git a/src/pages/index.tsx b/src/pages/index.tsx index c5325e5..19fb295 100644 --- a/src/pages/index.tsx +++ b/src/pages/index.tsx @@ -11,6 +11,7 @@ function HomepageHeader() { const {siteConfig} = useDocusaurusContext(); return (
+

{siteConfig.title}

{siteConfig.tagline}