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.

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

feat: delia docs #820

Merged
merged 2 commits into from
Apr 7, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions docs/src/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@
- [`client`](./storage-provider-cli/client/index.md)
- [`wallet`](./storage-provider-cli/client/wallet.md)
- [`proofs`](./storage-provider-cli/client/proofs.md)
- [Delia](./delia/index.md)
- [Storagext CLI](./storagext-cli/index.md)
- [`market`](./storagext-cli/market.md)
- [`storage-provider`](./storagext-cli/storage-provider.md)
Expand Down
67 changes: 67 additions & 0 deletions docs/src/delia/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
# Delia: Frontend for Polka Storage

<div class="warning">
This project is under active development!
</div>

The Delia project is a complement to the [Polka Storage](https://github.com/eigerco/polka-storage) project, being the frontend for file upload to the network's providers.

## Getting Started

The stack aims to be straightforward and opinionated, using Typescript, Vite and Biome as the major development tools and React & Tailwind for the frontend due to their ubiquity.

### Prerequisites

- [pnpm](https://pnpm.io/installation) package manager
- A Polkadot.js browser extension with an account
- Sufficient funds in your account for creating storage deals

### Installation

```bash
pnpm i
```

### Running the Development Server

```bash
pnpm run dev
```

## User Guide

### Accounts

As a user, Delia will require you to use the Polkadot.js browser extension,
for testing purposes, we recommend you add Alice's account to your wallet,
the seed phrase for it is <sup><a href="https://stackoverflow.com/a/70518514">1</a>,
<a href="https://github.com/polkadot-developers/substrate-developer-hub.github.io/issues/613">2</a></sup>:

```
bottom drive obey lake curtain smoke basket hold race lonely fit walk//Alice
```

If you're using your own keys, you will need to have funds available to perform deals. For details on obtaining funds in a local testnet, refer to the [Getting Funds](../getting-started/local-testnet/getting-funds.md) section.

### Preparing a deal

#### Filling in information about your file

<img src="../images/deal-form.png" style="height: 300px; float:right;"/>

- **Piece CID** — A unique identifier for your file, it is calculated with the `polka-storage-provider-client proofs commp` tool.
- **Piece Size** — The piece size for your file, it is calculated with the `polka-storage-provider-client` tool (this number _MUST_ be a power of two).
- **Label** — A string up to 128 characters long, can contain anything you wish.
- **Start Block** — The block at which the deal becomes active.
- **End Block** — The block at which the deal ends.
- **Price-per-block** — The price to pay for each block during which the file is stored.
- **Provider Collateral** — The price the storage provider gives up if they fail to uphold their end of the deal.

#### Selecting your storage provider

<img src="../images/select-provider.png" style="width: 300px; float:right;"/>

- **Refresh** — Will fetch the list of storage providers.
- **Storage Provider** — The storage provider's account ID, Peer ID and supported sector size.

// TODO: Downloading
Binary file added docs/src/images/deal-form.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/src/images/select-provider.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.