Skip to content
This repository was archived by the owner on Aug 7, 2025. It is now read-only.

Commit 087f382

Browse files
committed
updats to docs
1 parent 58dda90 commit 087f382

File tree

11 files changed

+63
-526
lines changed

11 files changed

+63
-526
lines changed

guides/rollkit-monitoring.md

Lines changed: 0 additions & 56 deletions
This file was deleted.

guides/use-rollkit-cli.md

Lines changed: 0 additions & 73 deletions
This file was deleted.

tutorials/da/celestia-da.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,8 +44,8 @@ After successfully starting a light node, it's time to start posting the batches
4444

4545
## 🏗️ Prerequisites {#prerequisites}
4646

47-
* `rollkit` CLI installed from the [quick start](/tutorials/quick-start) tutorial.
48-
47+
- `rollkit` CLI installed from the [quick start](/tutorials/quick-start) tutorial.
48+
4949
## 🛠️ Configuring flags for DA
5050

5151
Now that we are posting to the Celestia DA instead of the local DA, the `rollkit start` command requires three DA configuration flags:
@@ -143,6 +143,7 @@ Now, the rollup is running and posting blocks (aggregated in batches) to Celesti
143143
For example, [here on Celenium for Arabica](https://arabica.celenium.io/).
144144

145145
Other explorers:
146+
146147
- [Arabica testnet](https://docs.celestia.org/nodes/arabica-testnet#explorers)
147148
- [Mocha testnet](https://docs.celestia.org/nodes/mocha-testnet#explorers)
148149
- [Mainnet Beta](https://docs.celestia.org/nodes/mainnet#explorers)

tutorials/da/local-da.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ import constants from '../../.vitepress/constants/constants.js'
77

88
## Introduction {#introduction}
99

10-
This tutorial serves as a comprehensive guide for using the [local-da](https://github.com/rollkit/local-da) with your chain.
10+
This tutorial serves as a comprehensive guide for using the [local-da](https://github.com/rollkit/local-da) with your chain.
1111

1212
Before proceeding, ensure that you have completed the [quick start](/tutorials/quick-start) or [build a chain](/tutorials/wordle) tutorial, which covers installing the rollkit CLI, building your chain, and running your chain.
1313

@@ -23,7 +23,7 @@ This script will build and run the node, which will then listen on port `7980`.
2323

2424
## Configuring your rollup to connect to the local DA network
2525

26-
To connect your rollup to the local DA network, you need to pass the `--rollkit.da_address` flag with the local DA node address.
26+
To connect your rollup to the local DA network, you need to pass the `--rollkit.da.address` flag with the local DA node address.
2727

2828
## Run your rollup
2929

@@ -32,11 +32,11 @@ Start your rollup node with the following command, ensuring to include the DA ad
3232
::: code-group
3333

3434
```sh [Quick Start]
35-
rollkit start --rollkit.da_address http://localhost:7980
35+
{BINARY} start --rollkit.da_address http://localhost:7980
3636
```
3737

3838
```sh [Wordle Chain]
39-
rollkit start \
39+
{BINARY} start \
4040
--rollkit.aggregator \
4141
--rollkit.da_address http://localhost:7980 \
4242
--rollkit.sequencer_rollup_id wordle
@@ -47,9 +47,11 @@ rollkit start \
4747
You should see the following log message indicating that your rollup is connected to the local DA network:
4848

4949
```shell
50-
I[2024-11-15|14:54:19.842] DA server is already running module=main address=http://localhost:7980
50+
11:07AM INF NewLocalDA: initialized LocalDA module=local-da
51+
11:07AM INF Listening on host=localhost maxBlobSize=1974272 module=da port=7980
52+
11:07AM INF server started listening on=localhost:7980 module=da
5153
```
5254

5355
## Summary
5456

55-
By following these steps, you will set up a local DA network node and configure your rollup to post data to it. This setup is useful for testing and development in a controlled environment.
57+
By following these steps, you will set up a local DA network node and configure your rollup to post data to it. This setup is useful for testing and development in a controlled environment. You can find more information on running the local-da binary [here](https://github.com/rollkit/rollkit/blob/main/da/cmd/local-da/README.md)

tutorials/da/overview.md

Lines changed: 36 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,24 +10,54 @@ Now that you have the foundations of running and building a rollup with Rollkit,
1010

1111
The first choice you need to make is which data availability (DA) layer to use. The DA layer is a critical component of a blockchain, as it provides the data availability and finality guarantees that your chain needs to operate securely.
1212

13-
Rollkit uses the [go-da interface](https://github.com/rollkit/go-da) to communicate to DA layers. Any DA layer that implements this interface can be used with Rollkit.
13+
Rollkit uses the [core da interface](https://github.com/rollkit/rollkit/blob/main/core/da/da.go#L11) to communicate to DA layers. Any DA layer that implements this interface can be used with Rollkit.
1414

15-
## Go DA {#go-da}
15+
## DA {#go-da}
1616

17-
The [go-da interface](https://github.com/rollkit/go-da) defines the core functions required to interact with a DA layer. Probably the two most important functions being `Get` and `Submit`.
17+
The [DA interface](https://github.com/rollkit/rollkit/blob/main/core/da/da.go#L11) defines the core functions required to interact with a DA layer. Probably the two most important functions being `Get` and `Submit`.
1818

1919
```go
2020
// DA defines very generic interface for interaction with Data Availability layers.
2121
type DA interface {
22+
// MaxBlobSize returns the max blob size
23+
MaxBlobSize(ctx context.Context) (uint64, error)
24+
2225
// Get returns Blob for each given ID, or an error.
23-
Get(ctx context.Context, ids []ID, namespace Namespace) ([]Blob, error)
26+
//
27+
// Error should be returned if ID is not formatted properly, there is no Blob for given ID or any other client-level
28+
// error occurred (dropped connection, timeout, etc).
29+
Get(ctx context.Context, ids []ID, namespace []byte) ([]Blob, error)
30+
31+
// GetIDs returns IDs of all Blobs located in DA at given height.
32+
GetIDs(ctx context.Context, height uint64, namespace []byte) (*GetIDsResult, error)
33+
34+
// GetProofs returns inclusion Proofs for Blobs specified by their IDs.
35+
GetProofs(ctx context.Context, ids []ID, namespace []byte) ([]Proof, error)
36+
37+
// Commit creates a Commitment for each given Blob.
38+
Commit(ctx context.Context, blobs []Blob, namespace []byte) ([]Commitment, error)
2439

2540
// Submit submits the Blobs to Data Availability layer.
26-
Submit(ctx context.Context, blobs []Blob, gasPrice float64, namespace Namespace) ([]ID, error)
41+
//
42+
// This method is synchronous. Upon successful submission to Data Availability layer, it returns the IDs identifying blobs
43+
// in DA.
44+
Submit(ctx context.Context, blobs []Blob, gasPrice float64, namespace []byte) ([]ID, error)
45+
46+
// SubmitWithOptions submits the Blobs to Data Availability layer with additional options.
47+
SubmitWithOptions(ctx context.Context, blobs []Blob, gasPrice float64, namespace []byte, options []byte) ([]ID, error)
48+
49+
// Validate validates Commitments against the corresponding Proofs. This should be possible without retrieving the Blobs.
50+
Validate(ctx context.Context, ids []ID, proofs []Proof, namespace []byte) ([]bool, error)
51+
52+
// GasPrice returns the gas price for the DA layer.
53+
GasPrice(ctx context.Context) (float64, error)
54+
55+
// GasMultiplier returns the gas multiplier for the DA layer.
56+
GasMultiplier(ctx context.Context) (float64, error)
2757
}
2858
```
2959

30-
DA layers can integrate the `go-da` interface directly into their node like [Celestia](celestia-da), or they can define a middleware service like [Avail](avail-da).
60+
DA layers can integrate the `da` interface directly into their node like [Celestia](celestia-da).
3161

3262
## Mock DA {#mock-da}
3363

tutorials/execution/cosmwasm.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -30,13 +30,14 @@ this tutorial.
3030

3131
## 💻 CosmWasm dependency {#dependencies}
3232

33-
As with the [GM Rollup](https://rollkit.dev/tutorials/gm-world), we use [kurtosis](https://docs.kurtosis.com/) to help with managing all the services we need to run. You can [install kurtosis here](https://docs.kurtosis.com/install).
33+
As with the [GM Rollup](https://rollkit.dev/tutorials/gm-world), we use [kurtosis](https://docs.kurtosis.com/) to help with managing all the services we need to run. You can [install kurtosis here](https://docs.kurtosis.com/install).
3434

3535
Once installed, you can verify the installation by running:
3636

3737
```bash
3838
kurtosis version
3939
```
40+
4041
```bash
4142
CLI Version: 0.90.1
4243

@@ -104,6 +105,7 @@ Kurtosis has successfully launched the CosmWasm rollup and the local DA network.
104105
```bash
105106
docker ps
106107
```
108+
107109
```bash
108110
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
109111
5bfeda0a871f ghcr.io/rollkit/cosmwasm:v0.1.0 "/bin/sh -c 'wasmd s…" About a minute ago Up About a minute 0.0.0.0:9290->9290/tcp, 0.0.0.0:36656-36657->36656-36657/tcp wasm--c71b0308616d40ad919ad24c3d14f35b
@@ -119,7 +121,7 @@ We can see the CosmWasm rollup running in container `wasm--c71b0308616d40ad919ad
119121

120122
Let's hold on to the container name for the CosmWasm rollup, as we will need it later.
121123

122-
```bash
124+
```bash
123125
CW=$(docker ps --format '{{.Names}}' | grep wasm)
124126
echo $CW
125127
```
@@ -129,6 +131,7 @@ You can verify the rollup is running by checking the logs:
129131
```bash
130132
docker logs $CW
131133
```
134+
132135
```bash
133136
...
134137
3:55PM INF Creating and publishing block height=137 module=BlockManager
@@ -157,7 +160,7 @@ docker pull ghcr.io/rollkit/contract:v0.2.0
157160

158161
Then run the container:
159162

160-
```bash
163+
```bash
161164
docker run --rm -d --name cw ghcr.io/rollkit/contract:v0.2.0
162165
```
163166

@@ -208,7 +211,7 @@ docker exec -it $CW sh
208211

209212
In order to deploy a contract, you can use the command line as described below.
210213
For a better experience and to use Rust code instead of the command line to
211-
deploy/script and test your contracts, you can use [cw-orchestrator](/guides/cw-orch.md).
214+
deploy/script and test your contracts, you can use [cw-orchestrator](/guides/cw-orch.md).
212215

213216
<!-- markdownlint-disable MD013 -->
214217
```bash
@@ -230,7 +233,7 @@ the variables in the command with the variables in the `init.sh` script.
230233
In the previous steps, we have stored out contract's tx hash in an
231234
environment variable for later use.
232235

233-
The following guide will show you how to deploy and interact with a contract using CLI.
236+
The following guide will show you how to deploy and interact with a contract using CLI.
234237
For scripting using Rust, you can use [cw-orchestrator](/guides/cw-orch.md).
235238

236239
### 🔎 Contract querying {#contract-querying}

0 commit comments

Comments
 (0)