Skip to content

Commit 0ea3d02

Browse files
MSeveyMSevey
authored
chore: add execution API disclaimer to docs (#521)
1 parent dad10ef commit 0ea3d02

File tree

8 files changed

+104
-26
lines changed

8 files changed

+104
-26
lines changed

‎.vitepress/components/execution_callout.vue

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
<template>
2+
<div>
3+
<p>Rollkit is currently undergoing an execution overhaul with the
4+
creation of the <a
5+
href="https://github.com/rollkit/go-execution">go-execution
6+
interface</a>. In the meantime, the execution tutorials should be
7+
considered out of date until they have been updated to use the new
8+
execution API. If you have question about a specific execution
9+
environment, please create a GitHub <a
10+
href="https://github.com/rollkit/docs/issues/new">issue ticket</a> or
11+
reach out in our <a href="https://t.me/rollkit">Telegram group</a>.</p>
12+
</div>
13+
</template>
14+
15+
<script>
16+
export default {
17+
name: 'ExecutionCallout',
18+
}
19+
</script>
20+
21+
<style scoped>
22+
/* Add any custom styles for the component here */
23+
</style>

‎.vitepress/config.ts

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -275,20 +275,19 @@ function sidebarHome() {
275275
text: "Execution",
276276
collapsed: true,
277277
items: [
278-
{ text: "CosmWasm", link: "/tutorials/cosmwasm" },
278+
{ text: "CosmWasm", link: "/tutorials/execution/cosmwasm" },
279279
{
280280
text: "EVM",
281281
collapsed: true,
282282
items: [
283-
{ text: "Omni Octane EVM", link: "/tutorials/octane-evm" },
284-
{ text: "BeaconKit EVM", link: "/tutorials/beaconkit" },
283+
{ text: "BeaconKit EVM", link: "/tutorials/execution/beaconkit" },
285284
{
286285
text: "Artela EVM++",
287-
link: "/tutorials/artela-evm-plus-plus",
286+
link: "/tutorials/execution/artela-evm-plus-plus",
288287
},
289288
{
290289
text: "Contract interaction",
291-
link: "/tutorials/evm-contract-interaction",
290+
link: "/tutorials/execution/evm-contract-interaction",
292291
},
293292
],
294293
},

‎tutorials/artela-evm-plus-plus.md renamed to ‎tutorials/execution/artela-evm-plus-plus.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,19 @@
11
# Quick Start Guide for Artela EVM++ with Rollkit
22

3+
<!-- markdownlint-disable MD033 -->
34
<script setup>
4-
import constants from '../.vitepress/constants/constants.js'
5+
import Callout from '../../.vitepress/components/callout.vue'
6+
import ExecutionCallout from '../../.vitepress/components/execution_callout.vue'
7+
import constants from '../../.vitepress/constants/constants.js'
58
</script>
9+
<!-- markdownlint-enable MD033 -->
10+
11+
:::tip
12+
<Callout />
13+
:::
14+
:::warning
15+
<ExecutionCallout />
16+
:::
617

718
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.
819

‎tutorials/beaconkit.md renamed to ‎tutorials/execution/beaconkit.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,18 @@
22

33
<!-- markdownlint-disable MD033 -->
44
<script setup>
5-
import constants from '../.vitepress/constants/constants.js'
5+
import Callout from '../../.vitepress/components/callout.vue'
6+
import ExecutionCallout from '../../.vitepress/components/execution_callout.vue'
7+
import constants from '../../.vitepress/constants/constants.js'
68
</script>
9+
<!-- markdownlint-enable MD033 -->
10+
11+
:::tip
12+
<Callout />
13+
:::
14+
:::warning
15+
<ExecutionCallout />
16+
:::
717

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

‎tutorials/cosmwasm.md renamed to ‎tutorials/execution/cosmwasm.md

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,24 @@
11
# 🗞️ CosmWasm rollup
22

3-
CosmWasm is a smart contracting platform built for the Cosmos
4-
ecosystem by making use of [WebAssembly](https://webassembly.org) (Wasm)
5-
to build smart contracts for Cosmos-SDK. In this tutorial, we will be
6-
exploring how to integrate CosmWasm with local DA layer using Rollkit.
7-
83
<!-- markdownlint-disable MD033 -->
94
<script setup>
10-
import Callout from '../.vitepress/components/callout.vue'
11-
import constants from '../.vitepress/constants/constants.js'
5+
import Callout from '../../.vitepress/components/callout.vue'
6+
import ExecutionCallout from '../../.vitepress/components/execution_callout.vue'
7+
import constants from '../../.vitepress/constants/constants.js'
128
</script>
9+
<!-- markdownlint-enable MD033 -->
1310

1411
:::tip
1512
<Callout />
1613
:::
17-
<!-- markdownlint-enable MD033 -->
14+
:::warning
15+
<ExecutionCallout />
16+
:::
17+
18+
CosmWasm is a smart contracting platform built for the Cosmos
19+
ecosystem by making use of [WebAssembly](https://webassembly.org) (Wasm)
20+
to build smart contracts for Cosmos-SDK. In this tutorial, we will be
21+
exploring how to integrate CosmWasm with local DA layer using Rollkit.
1822

1923
The smart contract we will use for this tutorial is one provided by
2024
the CosmWasm team for Nameservice purchasing.

‎tutorials/evm-contract-interaction.md renamed to ‎tutorials/execution/evm-contract-interaction.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,20 @@
11
# Smart Contract Interaction on EVM Rollup
22

3+
<!-- markdownlint-disable MD033 -->
4+
<script setup>
5+
import Callout from '../../.vitepress/components/callout.vue'
6+
import ExecutionCallout from '../../.vitepress/components/execution_callout.vue'
7+
import constants from '../../.vitepress/constants/constants.js'
8+
</script>
9+
<!-- markdownlint-enable MD033 -->
10+
11+
:::tip
12+
<Callout />
13+
:::
14+
:::warning
15+
<ExecutionCallout />
16+
:::
17+
318
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.
419

520
## Install Foundry

‎tutorials/octane-evm.md renamed to ‎tutorials/execution/octane-evm.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,19 @@
11
# Quick start guide for Omni Octane with Rollkit
22

3+
<!-- markdownlint-disable MD033 -->
34
<script setup>
4-
import constants from '../.vitepress/constants/constants.js'
5+
import Callout from '../../.vitepress/components/callout.vue'
6+
import ExecutionCallout from '../../.vitepress/components/execution_callout.vue'
7+
import constants from '../../.vitepress/constants/constants.js'
58
</script>
9+
<!-- markdownlint-enable MD033 -->
10+
11+
:::tip
12+
<Callout />
13+
:::
14+
:::warning
15+
<ExecutionCallout />
16+
:::
617

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

‎tutorials/polaris-evm.md renamed to ‎tutorials/execution/polaris-evm.md

Lines changed: 15 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,20 @@
11
# Polaris EVM and Rollkit
22

3+
<!-- markdownlint-disable MD033 -->
4+
<script setup>
5+
import Callout from '../../.vitepress/components/callout.vue'
6+
import ExecutionCallout from '../../.vitepress/components/execution_callout.vue'
7+
import constants from '../../.vitepress/constants/constants.js'
8+
</script>
9+
<!-- markdownlint-enable MD033 -->
10+
11+
:::tip
12+
<Callout />
13+
:::
14+
:::warning
15+
<ExecutionCallout />
16+
:::
17+
318
::: danger
419
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.
520
:::
@@ -14,16 +29,6 @@ layer. This integration uses a local-celestia-devnet. Rollkit
1429
is used to deploy a Polaris EVM rollup without needing to set up a data
1530
availability and consensus network.
1631

17-
<!-- markdownlint-disable MD033 -->
18-
<script setup>
19-
import Callout from '../.vitepress/components/callout.vue'
20-
</script>
21-
22-
:::tip
23-
<Callout />
24-
:::
25-
<!-- markdownlint-enable MD033 -->
26-
2732
## Prerequisites
2833

2934
Before you can run Polaris EVM using Rollkit, you need to have the

0 commit comments

Comments
 (0)