Skip to content

Commit

Permalink
doc: WIP readme.md
Browse files Browse the repository at this point in the history
  • Loading branch information
dumbeng committed Aug 20, 2024
1 parent 260c828 commit 1a2821e
Show file tree
Hide file tree
Showing 21 changed files with 75 additions and 98 deletions.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
2 changes: 1 addition & 1 deletion Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ WORKDIR /app/artela-rollkit
RUN rollkit toml init

# Edit rollkit.toml config_dir
RUN sed -i 's/config_dir = "artela"/config_dir = "\.\/\.artela"/g' rollkit.toml
RUN sed -i 's/config_dir = "artroll"/config_dir = "\.\/\.artroll"/g' rollkit.toml

# Run base rollkit command to download packages
RUN rollkit
Expand Down
2 changes: 1 addition & 1 deletion compose.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ services:
platform: linux/amd64

# The command config is used for launching the GM rollup once the Docker container is running
# command: rollkit start --rollkit.aggregator --rollkit.da_address http://localhost:7980
command: rollkit start --rollkit.aggregator --rollkit.da_address http://local-da:7980
depends_on:
- local-da

Expand Down
4 changes: 0 additions & 4 deletions kurtosis.yml

This file was deleted.

62 changes: 0 additions & 62 deletions main.star

This file was deleted.

103 changes: 73 additions & 30 deletions readme.md
Original file line number Diff line number Diff line change
@@ -1,51 +1,94 @@
# artela-rollkit
**artela-rollkit** is a rollup kit built using Celestia's rollkit and created with [Ignite CLI](https://ignite.com/cli).
<h1 align="center"> Artela Rollkit </h1>

## Get started
<div align="center">
<a href="https://t.me/artela_official" target="_blank">
<img alt="Telegram Chat" src="https://img.shields.io/badge/chat-telegram-blue?logo=telegram&chat">
</a>
<a href="https://twitter.com/Artela_Network" target="_blank">
<img alt="Twitter Follow" src="https://img.shields.io/twitter/follow/Artela_Network">
<a href="https://discord.gg/artela">
<img src="https://img.shields.io/badge/chat-discord-green?logo=discord&chat" alt="Discord">
</a>
<a href="https://www.artela.network/">
<img src="https://img.shields.io/badge/Artela%20Network-3282f8" alt="Artela Network">
</a>
</div>

## Introduction

```
ignite chain serve
```

`serve` command installs dependencies, builds, initializes, and starts your blockchain in development.
Artela Rollkit is a rollup kit built with [Celestia's Rollkit](https://github.com/rollkit/rollkit), it empowers developers to add user-defined native extensions and build feature-rich dApps. It offers extensibility that goes beyond EVM-equivalence, inter-domain interoperability, and boundless scalability with its Elastic Block Space design.

### Configure
As the first rollup kit equipped with Aspects, Artela network aims to **maximize the value of Aspect and enable developers to build feature-rich dApps.**
<p align="center">
<img src="https://docs.artela.network/assets/images/2-a4045260ad64e65eaa2af9fc50c06a4a.png" width="500" height="500">
</p>

Your blockchain in development can be configured with `config.yml`. To learn more, see the [Ignite CLI docs](https://docs.ignite.com).
* **Base Layer:** Provide basic functions, including consensus engine, networking, EVM environments for the smart contract execution, and WASM environments for the Aspects execution. This layer is launched by Artela.

### Web Frontend
* **Extension Layer:** Provide the Aspect SDK. Developers are able to build Aspects. Aspects have access to all APIs within the base layer and can be freely combined with smart contracts and other Aspects. Aspect is securely isolated from Base Layer, ensuring that it has no impact on the security or availability of the core network.

Additionally, Ignite CLI offers both Vue and React options for frontend scaffolding:
* **Application Layer:** Developers can build smart contracts as usual. Initially, EVM will be provided for the seamless landing of most dApps in crypto.

For a Vue frontend, use: `ignite scaffold vue`
For a React frontend, use: `ignite scaffold react`
These commands can be run within your scaffolded blockchain project.

## Build the source

For more information see the [monorepo for Ignite front-end development](https://github.com/ignite/web).
1). Set Up Your Go Development Environment<br />
Make sure you have set up your Go programming language development environment.

## Release
To release a new version of your blockchain, create and push a new tag with `v` prefix. A new draft release with the configured targets will be created.
2). Install ignite-cli<br />

```sh
curl https://get.ignite.com/[email protected]! | bash
```
git tag v0.1
git push origin v0.1

3). Install rollkit-cli <br />

```sh
curl -sSL https://rollkit.dev/install.sh | sh -s v0.13.6
```

After a draft release is created, make your final changes from the release page and publish it.
4). Download the Source Code<br />
Obtain the project source code using the following method:

### Install
To install the latest version of your blockchain node's binary, execute the following command on your machine:
```
git clone https://github.com/artela-network/artela-rollkit.git
```

5). Compile<br />
Compile the source code and generate the executable using the Go compiler:

```
curl https://get.ignite.com/username/artela@latest! | sudo bash
ignite chain build
```
`username/artela` should match the `username` and `repo_name` of the Github repository to which the source code was pushed. Learn more about [the install process](https://github.com/allinbits/starport-installer).

## Learn more
## Executables

| Command | Description|
| :--------: | --------------------------------------------------------------------------------------------------------------|
| **`artela-rollkitd`** | artela-rollkitd is the core software of the Artela network. |

## Running a local dev node

1. Start `local-da` for the local development environment, make sure you have docker installed:

```sh
docker run --name local-da -tid -p 7980:7980 ghcr.io/rollkit/local-da:v0.2.1
```

if you prefer to run the local-da from the source code, you can find it out [here](https://github.com/rollkit/local-da).

2. Start `artela-rollkitd`:

```sh

```

---
Learn more about Artela in <https://artela.network/>


## License
Copyright © Artela Network, Inc. All rights reserved.

- [Ignite CLI](https://ignite.com/cli)
- [Tutorials](https://docs.ignite.com/guide)
- [Ignite CLI docs](https://docs.ignite.com)
- [Cosmos SDK docs](https://docs.cosmos.network)
- [Developer Chat](https://discord.gg/ignite)
Licensed under the [Apache v2](LICENSE) License.

0 comments on commit 1a2821e

Please sign in to comment.