Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: add execution API disclaimer to docs #521

Merged
merged 4 commits into from
Dec 2, 2024
Merged

chore: add execution API disclaimer to docs #521

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
5fa2005
chore: add execution API disclaimer to docs
MSevey Nov 21, 2024
88e1ba2
Update .vitepress/components/execution_callout.vue
MSevey Dec 2, 2024
e3e20b6
Merge branch 'main' into execution-api-disclaimer
MSevey Dec 2, 2024
5dd105e
chore: remove omni
MSevey Dec 2, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions .vitepress/components/execution_callout.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
<template>
<div>
<p>Rollkit is currently undergoing an execution overhaul with the
creation of the <a
href="https://github.com/rollkit/go-execution">go-execution
interface</a>. In the meantime, the execution tutorials should be
considered out of date until they have been updated to use the new
execution API. If you have question about a specific execution
environment, please create a GitHub <a
href="https://github.com/rollkit/docs/issues/new">issue ticket</a> or
reach out in our <a href="https://t.me/rollkit">Telegram group</a>.</p>
</div>
</template>

<script>
export default {
name: 'ExecutionCallout',
}
</script>

<style scoped>
/* Add any custom styles for the component here */
</style>
9 changes: 4 additions & 5 deletions .vitepress/config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -275,20 +275,19 @@ function sidebarHome() {
text: "Execution",
collapsed: true,
items: [
{ text: "CosmWasm", link: "/tutorials/cosmwasm" },
{ text: "CosmWasm", link: "/tutorials/execution/cosmwasm" },
{
text: "EVM",
collapsed: true,
items: [
{ text: "Omni Octane EVM", link: "/tutorials/octane-evm" },
{ text: "BeaconKit EVM", link: "/tutorials/beaconkit" },
{ text: "BeaconKit EVM", link: "/tutorials/execution/beaconkit" },
{
text: "Artela EVM++",
link: "/tutorials/artela-evm-plus-plus",
link: "/tutorials/execution/artela-evm-plus-plus",
},
{
text: "Contract interaction",
link: "/tutorials/evm-contract-interaction",
link: "/tutorials/execution/evm-contract-interaction",
},
],
},
Expand Down
13 changes: 12 additions & 1 deletion tutorials/artela-evm-plus-plus.md → tutorials/execution/artela-evm-plus-plus.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,19 @@
# Quick Start Guide for Artela EVM++ with Rollkit

<!-- markdownlint-disable MD033 -->
<script setup>
import constants from '../.vitepress/constants/constants.js'
import Callout from '../../.vitepress/components/callout.vue'
import ExecutionCallout from '../../.vitepress/components/execution_callout.vue'
import constants from '../../.vitepress/constants/constants.js'
</script>
<!-- markdownlint-enable MD033 -->

:::tip
<Callout />
:::
:::warning
<ExecutionCallout />
:::

This guide will assist you to quickly set up a rollup node with [Artela EVM++](https://docs.artela.network/main/Artela-Blockchain/EVM++) execution layer using Rollkit and local-DA.

Expand Down
12 changes: 11 additions & 1 deletion tutorials/beaconkit.md → tutorials/execution/beaconkit.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,18 @@

<!-- markdownlint-disable MD033 -->
<script setup>
import constants from '../.vitepress/constants/constants.js'
import Callout from '../../.vitepress/components/callout.vue'
import ExecutionCallout from '../../.vitepress/components/execution_callout.vue'
import constants from '../../.vitepress/constants/constants.js'
</script>
<!-- markdownlint-enable MD033 -->

:::tip
<Callout />
:::
:::warning
<ExecutionCallout />
:::

![beaconkit](https://camo.githubusercontent.com/b4a9b2b1d1536bb3dbbc32a5f3885b02dd1da8cdf9e34a160830d00ebee9120f/68747470733a2f2f7265732e636c6f7564696e6172792e636f6d2f6475763067343032792f696d6167652f75706c6f61642f76313731383033343331322f426561636f6e4b697442616e6e65722e706e67)

Expand Down
20 changes: 12 additions & 8 deletions tutorials/cosmwasm.md → tutorials/execution/cosmwasm.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,20 +1,24 @@
# 🗞️ CosmWasm rollup

CosmWasm is a smart contracting platform built for the Cosmos
ecosystem by making use of [WebAssembly](https://webassembly.org) (Wasm)
to build smart contracts for Cosmos-SDK. In this tutorial, we will be
exploring how to integrate CosmWasm with local DA layer using Rollkit.

<!-- markdownlint-disable MD033 -->
<script setup>
import Callout from '../.vitepress/components/callout.vue'
import constants from '../.vitepress/constants/constants.js'
import Callout from '../../.vitepress/components/callout.vue'
import ExecutionCallout from '../../.vitepress/components/execution_callout.vue'
import constants from '../../.vitepress/constants/constants.js'
</script>
<!-- markdownlint-enable MD033 -->

:::tip
<Callout />
:::
<!-- markdownlint-enable MD033 -->
:::warning
<ExecutionCallout />
:::

CosmWasm is a smart contracting platform built for the Cosmos
ecosystem by making use of [WebAssembly](https://webassembly.org) (Wasm)
to build smart contracts for Cosmos-SDK. In this tutorial, we will be
exploring how to integrate CosmWasm with local DA layer using Rollkit.

The smart contract we will use for this tutorial is one provided by
the CosmWasm team for Nameservice purchasing.
Expand Down
15 changes: 15 additions & 0 deletions tutorials/evm-contract-interaction.md → ...als/execution/evm-contract-interaction.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,20 @@
# Smart Contract Interaction on EVM Rollup

<!-- markdownlint-disable MD033 -->
<script setup>
import Callout from '../../.vitepress/components/callout.vue'
import ExecutionCallout from '../../.vitepress/components/execution_callout.vue'
import constants from '../../.vitepress/constants/constants.js'
</script>
<!-- markdownlint-enable MD033 -->

:::tip
<Callout />
:::
:::warning
<ExecutionCallout />
:::

In this tutorial, you will deploy a smart contract to your EVM rollup and interact with it on a frontend. This tutorial assumes that you spinned up an EVM rollup, know it's RPC URL, and have funded an account on it.

## Install Foundry
Expand Down
13 changes: 12 additions & 1 deletion tutorials/octane-evm.md → tutorials/execution/octane-evm.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,19 @@
# Quick start guide for Omni Octane with Rollkit

<!-- markdownlint-disable MD033 -->
<script setup>
import constants from '../.vitepress/constants/constants.js'
import Callout from '../../.vitepress/components/callout.vue'
import ExecutionCallout from '../../.vitepress/components/execution_callout.vue'
import constants from '../../.vitepress/constants/constants.js'
</script>
<!-- markdownlint-enable MD033 -->

:::tip
<Callout />
:::
:::warning
<ExecutionCallout />
:::

This guide will help you quickly set up and run an Omni node using Rollkit and local-DA.

Expand Down
25 changes: 15 additions & 10 deletions tutorials/polaris-evm.md → tutorials/execution/polaris-evm.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,20 @@
# Polaris EVM and Rollkit

<!-- markdownlint-disable MD033 -->
<script setup>
import Callout from '../../.vitepress/components/callout.vue'
import ExecutionCallout from '../../.vitepress/components/execution_callout.vue'
import constants from '../../.vitepress/constants/constants.js'
</script>
<!-- markdownlint-enable MD033 -->

:::tip
<Callout />
:::
:::warning
<ExecutionCallout />
:::

::: danger
We regret to inform that Polaris V1 and Rollkit integration is not fully functional. Current issues are tracked in https://github.com/rollkit/rollkit/issues/1594. We are expecting Polaris V2 release soon and Rollkit support will be added along with update tutorial.
:::
Expand All @@ -14,16 +29,6 @@ layer. This integration uses a local-celestia-devnet. Rollkit
is used to deploy a Polaris EVM rollup without needing to set up a data
availability and consensus network.

<!-- markdownlint-disable MD033 -->
<script setup>
import Callout from '../.vitepress/components/callout.vue'
</script>

:::tip
<Callout />
:::
<!-- markdownlint-enable MD033 -->

## Prerequisites

Before you can run Polaris EVM using Rollkit, you need to have the
Expand Down
Loading