Skip to content

Commit 92287a8

Browse files
committed
docs: replace Blobs with Ikura
1 parent 59ffcdb commit 92287a8

File tree

5 files changed

+32
-28
lines changed

5 files changed

+32
-28
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
1-
# Blobs
1+
# Ikura
22

33
Blobchains on Polkadot and Kusama
44

55
## Project Structure
66

77
<pre>
8-
<a href=".">blobs</a>: The blobs monorepo.
8+
<a href=".">blobs</a>: The Ikura monorepo.
99
├──<a href="./adapters">adapters</a>: Adapters for various rollup development kits (RDK).
1010
│ ├── <a href="./adapters/rollkit">rollkit</a>: An adapter connecting Rollkit to Ikura
1111
│ ├── <a href="./adapters/sovereign">sovereign</a>: An adapter connecting Sovereign to Ikura.

docs-site/docs/intro.md

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,25 +4,29 @@ title: Introduction
44

55
---
66

7-
## Blobs
7+
## Ikura
88

9-
The Blobs project exposes **sequencing** and **data availability** capabilities of [Polkadot](https://polkadot.network) and [Kusama](https://kusama.network) for general use. Use-cases include rollups and inscriptions.
9+
Ikura exposes **sequencing** and **data availability** capabilities of [Polkadot](https://polkadot.network) and [Kusama](https://kusama.network) for general use. Use-cases include rollups and inscriptions.
1010

11-
The Blobs codebase is located at https://github.com/thrumdev/blobs. There is a live parachain on Kusama with Parachain ID 3338 running the Blobs runtime.
11+
The Ikura codebase is located at https://github.com/thrumdev/blobs.
1212

13-
In this documentation site, we'll often use the term Polkadot to refer to the Polkadot Relay Chain - the hub chain which provides security for everything running on Polkadot. Kusama runs on the same technology as Polkadot, so the Kusama version of Blobs works identically to the Polkadot version, just with a different network. You can mentally substitute "Polkadot" for "Kusama" when thinking about the Kusama version of Blobs.
13+
In this documentation site, we'll often use the term Polkadot to refer to the Polkadot Relay Chain - the hub chain which provides security for everything running on Polkadot. Kusama runs on the same technology as Polkadot, so the Kusama version of Ikura (Gondatsu) works identically to the Polkadot version, just with a different network. You can mentally substitute "Polkadot" for "Kusama" when thinking about the Kusama version of Ikura.
1414

15-
Blobs enables users to submit arbitrary data to the chain and receive guarantees about the availability of that data, as well as proofs of the order in which data were submitted. Namely:
15+
Ikura enables users to submit arbitrary data to the blockchain chain and receive guarantees about the availability of that data, as well as proofs of the order in which data were submitted. Those guarantees are:
1616
1. The data can be fetched from the Polkadot/Kusama validator set for up to 24 hours after submission and cannot be withheld.
1717
2. A commitment to the data's availability is stored within the blobchain and used as a proof of guarantee (1) to computer programs, such as smart contracts or Zero-Knowledge circuits.
1818

19-
Data Availability is a key component of Layer-2 scaling approaches, and is already part of Polkadot and Kusama for use in securing Parachains. Blobs will bring this capability out to much broader markets.
19+
Data Availability is a key component of Layer-2 scaling approaches, and is already part of Polkadot and Kusama for use in securing Parachains. Ikura will bring this capability to use-cases beyond parachains with a minimal interface.
2020

21-
Blobs makes a **relay-chain token utility commitment** now and forever. Submitting blobs will always make use of the DOT token on Polkadot and the KSM token on Kusama, as this is the approach with the least user friction.
21+
Ikura makes a **relay-chain token utility commitment** now and forever. Submitting blobs will always make use of the DOT token on Polkadot and the KSM token on Kusama, as this is the approach with the least user friction.
22+
23+
## Gondatsu
24+
25+
The version of Ikura targeting the Kusama network is **Gondatsu**. It has Parachain ID 3338 running. We currently do not make any long-term stability commitment for Gondatsu. Gondatsu currently is _centrally controlled_ with a sudo (admin) key. It is experimental.
2226

2327
## Integrations
2428

25-
Blobs supports a variety of rollup SDKs out of the box.
29+
Ikura supports a variety of rollup SDKs out of the box.
2630
- [x] Rollkit
2731
- [x] Sovereign SDK
2832
- [ ] OP Stack

docs-site/docs/node-operators/getting-started.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,18 +4,18 @@ title: Getting Started
44

55
## Releases
66

7-
At the moment, there are no downloadable binary releases available of the Blobs node. We recommend building a binary from source.
7+
At the moment, there are no downloadable binary releases available of the Ikura node. We recommend building a binary from source.
88

99
## Node Architecture
1010

11-
Blobs is a standard Polkadot-SDK parachain node, which means that it actually runs two nodes:
12-
1. A node for the Parachain (Blobs) on Polkadot or Kusama
11+
Ikura is a standard Polkadot-SDK parachain node, which means that it actually runs two nodes:
12+
1. A node for the Parachain (Ikura) on Polkadot or Kusama
1313
2. A node for the Relay Chain, Polkadot or Kusama.
1414

1515
You can pass arguments to each one of these underlying nodes with the following approach:
1616

1717
```sh
18-
./ikura-node --arg-for-blobs --arg2-for-blobs -- --arg-for-relay --arg2-for-relay
18+
./ikura-node --arg-for-ikura --arg2-for-ikura -- --arg-for-relay --arg2-for-relay
1919
```
2020

2121
## Hardware Requirements
@@ -58,9 +58,9 @@ Running the node:
5858
target/release/ikura-node --chain gondatsu
5959
```
6060

61-
## Blobs and Storage Usage
61+
## Ikura and Storage Usage
6262

63-
Blobs can potentially use enormous amounts of disk space under heavy usage. This is because all historical blobs are stored within the blobchain's history. While the Polkadot and Kusama expunge ancient blobs after 24 hours, any full node of the blobchain will have all the blobs going back to the genesis, as well as all of the other block data.
63+
Ikura can potentially use enormous amounts of disk space under heavy usage. This is because all historical blobs are stored within the blobchain's history. While the Polkadot and Kusama expunge ancient blobs after 24 hours, any full node of the blobchain will have all the blobs going back to the genesis, as well as all of the other block data.
6464

6565
To avoid this issue, run with `--blocks-pruning <number>`, where `number` is some relatively small value such as `1000` to avoid keeping all historical blobs.
6666

docs-site/docs/protocol/data-availability.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ sidebar_position: 1
33
title: Data Availability
44
---
55

6-
Blobs provides reliable and high-throughput Data Availability services. Before diving into exactly what this is, we'll take a quick detour through Rollup scaling solutions.
6+
Ikura provides reliable and high-throughput Data Availability services. Before diving into exactly what this is, we'll take a quick detour through Rollup scaling solutions.
77

88
## Rollup Architecture
99

@@ -26,23 +26,23 @@ Data Availability serves an additional purpose, which is to ensure that submitte
2626

2727
Regardless of which proving mechanism is used, sequencing and data availability are common to all protocols under this blueprint.
2828

29-
Rollups use Blobs for both sequencing and Data Availability.
29+
Rollups use Ikura for both sequencing and Data Availability.
3030

3131
## Data Availability
3232

33-
Blobs is a wrapper over Polkadot's Data Availability system. Any data made available via Blobs is using the Polkadot validators under the hood. In this section, we'll explore how Polkadot makes data available.
33+
Ikura is a wrapper over Polkadot's Data Availability system. Any data made available via Ikura is using the Polkadot validators under the hood. In this section, we'll explore how Polkadot makes data available.
3434

35-
A Blob consists of two things: a **namespace** and some **data**. The namespace is a kind of tag which allows for blobs to be filtered by an observer, and the data is just a bunch of bytes. To Blobs, the content of the blobs does not matter.
35+
A Blob consists of two things: a **namespace** and some **data**. The namespace is a kind of tag which allows for blobs to be filtered by an observer, and the data is just a bunch of bytes. To Ikura, the content of the blobs does not matter.
3636

37-
Blobs is a blockchain secured by Polkadot, where the blocks may contain Blob transactions.
37+
Ikura is a blockchain secured by Polkadot, where the blocks may contain Blob transactions.
3838

3939
Every block is erasure-coded, replicated, and distributed across Polkadot's entire validator set. The block is split up into pieces, with one piece for each Polkadot validator. Any set of more than one-third of the pieces is enough to recover the entire data.
4040

4141
### Example: The Path of a Blob
42-
1. First, the user signs a transaction containing the Blob and submits it to a Blobs node.
43-
2. Once the transaction has circulated through the network, a Blobs block authoring node bundles it into a block.
42+
1. First, the user signs a transaction containing the Blob and submits it to an Ikura node.
43+
2. Once the transaction has circulated through the network, a Ikura block authoring node bundles it into a block.
4444
3. The block authoring node submits the block to some assigned Polkadot validators.
45-
4. Those Polkadot validators approve the Blobs block and the Blobs block's header is placed into a Polkadot Relay Chain Block
46-
5. After this, the Blobs block, including all the transactions within it, is erasure-coded and split into redundant pieces, one for each Polkadot validator.
45+
4. Those Polkadot validators approve the Ikura block and the Ikura block's header is placed into a Polkadot Relay Chain Block
46+
5. After this, the Ikura block, including all the transactions within it, is erasure-coded and split into redundant pieces, one for each Polkadot validator.
4747
6. Each validator attempts to fetch their piece over the p2p network. Polkadot requires that at least two-thirds of validators sign a statement that they have fetched and stored their piece, or the whole process must revert back to step (2).
4848

docs-site/docusaurus.config.js

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ import {themes as prismThemes} from 'prism-react-renderer';
88

99
/** @type {import('@docusaurus/types').Config} */
1010
const config = {
11-
title: 'Blobs - Documentation',
11+
title: 'Ikura - Documentation',
1212
tagline: 'Blobchains on Polkadot and Kusama',
1313
favicon: 'img/blobs-favicon-line.webp',
1414

@@ -21,7 +21,7 @@ const config = {
2121
// GitHub pages deployment config.
2222
// If you aren't using GitHub pages, you don't need these.
2323
organizationName: 'ThrumDev', // Usually your GitHub org/user name.
24-
projectName: 'blobs', // Usually your repo name.
24+
projectName: 'Ikura', // Usually your repo name.
2525

2626
onBrokenLinks: 'throw',
2727
onBrokenMarkdownLinks: 'warn',
@@ -60,7 +60,7 @@ const config = {
6060
// Replace with your project's social card
6161
image: 'img/docusaurus-social-card.jpg',
6262
navbar: {
63-
title: 'Blobs',
63+
title: 'Ikura',
6464
logo: {
6565
alt: 'Thrum Logo',
6666
src: './img/blobs-simple.png',

0 commit comments

Comments
 (0)