diff --git a/docs/src/architecture/pallets/index.md b/docs/src/architecture/pallets/index.md index dc79821e0..30ff44e85 100644 --- a/docs/src/architecture/pallets/index.md +++ b/docs/src/architecture/pallets/index.md @@ -28,7 +28,7 @@ After publishing, the funds allocated for the deal will be moved from `free` to Publishing storage deals At this point, the remaining responsibility is shifted to the storage provider, which needs to activate the deal. -First, the storage provider needs to call `get_randomness` from the[Randomness Pallet](./randomness.md) in order to create a replica and +First, the storage provider needs to call `get_randomness` from the [Randomness Pallet](./randomness.md) in order to create a replica and [pre-commit](./storage-provider.md#pre_commit_sectors) the deal's sectors. The sealing and pre-committing takes some time, after that the storage provider needs to fetch yet another randomness seed to create a proof. Subsequently, they [prove](./storage-provider.md#prove_commit_sectors) they stored the sectors by calling [`prove_commit_sectors`](./storage-provider.md#prove_commit_sectors) extrinsics. diff --git a/docs/src/architecture/pallets/market.md b/docs/src/architecture/pallets/market.md index e0a74e81c..504db7ad5 100644 --- a/docs/src/architecture/pallets/market.md +++ b/docs/src/architecture/pallets/market.md @@ -197,7 +197,7 @@ The Market Pallet emits the following events: - `DealsSettled` - Published after the `settle_deal_payments` extrinsic is called. Indicates which deals were successfully and unsuccessfully settled. - `successful` - List of deal IDs that were settled - `unsuccessful` - List of deal IDs with the corresponding errors -- `DealSlashed` - Is emitted when some deal expired +- `DealSlashed` - Is emitted when some deal expired. - `deal_id` - Deal ID that was slashed - `DealTerminated` - A deal was voluntarily or involuntarily terminated. - `deal_id` - Terminated deal ID diff --git a/docs/src/getting-started/building/source.md b/docs/src/getting-started/building/source.md index 4256b999f..59126edc0 100644 --- a/docs/src/getting-started/building/source.md +++ b/docs/src/getting-started/building/source.md @@ -74,6 +74,7 @@ for more information refer to the official Nix guide — https://nix.dev/manual/ After all this setup, it is time to start building the binaries, which you can do manually using the following command:
+ When building `polka-storage-node` you should add `--features polka-storage-runtime/testnet` which enables the testnet configuration; all the code in the repo is currently targeting this feature, not including it may lead to unexpected behavior. When building `storagext-cli` you may want to add `--features storagext/insecure_url` which enables using non-TLS HTTP and WebSockets. @@ -91,7 +92,6 @@ Where `` is one of: - `storagext-cli` - `mater-cli` -Additionally, if you're building `polka-storage-node` or `storagext-cli` there are features that you may want to enable: For more information on what each binary does, refer to [Building](./index.md). diff --git a/docs/src/getting-started/local-testnet/index.md b/docs/src/getting-started/local-testnet/index.md index e52ea3e56..d05dadb71 100644 --- a/docs/src/getting-started/local-testnet/index.md +++ b/docs/src/getting-started/local-testnet/index.md @@ -8,7 +8,7 @@ Charlie will be our contact point to the parachain network. ## Native Binaries -The binaries for the latest releases are available to download and can be ran without any additional dependencies. +The binaries for the latest releases are available to download and can be run without any additional dependencies. We support `Linux x86_64` and `MacOS ARM x64`. The commands below will download: - [Relay Chain](https://github.com/paritytech/polkadot-sdk/releases) binaries (`polkadot`, `polkadot-prepare-worker`, `polkadot-execute-worker`), diff --git a/docs/src/getting-started/storage-provider.md b/docs/src/getting-started/storage-provider.md index eca128a1e..b6f3d8af9 100644 --- a/docs/src/getting-started/storage-provider.md +++ b/docs/src/getting-started/storage-provider.md @@ -78,7 +78,15 @@ polka-storage-provider-server \ --X-key ``` -Where `--X-key ` matches the key type you used to register yourself with the network, in the previous step. +Where `--X-key ` matches the key type you used to register yourself with the network, in the previous step. For example: +```bash +polka-storage-provider-server \ + --seal-proof 2KiB \ + --post-proof 2KiB \ + --porep-parameters "2KiB.porep.params" \ + --sr25519-key "//Charlie" +``` + Note that currently, `--seal-proof` and `--post-proof` only support `2KiB`. `` is the resulting `*.porep.params` file from the [first steps](#generating-the-porep-parameters), diff --git a/docs/src/storage-provider-cli/client/index.md b/docs/src/storage-provider-cli/client/index.md index ad3a2559b..518b990f2 100644 --- a/docs/src/storage-provider-cli/client/index.md +++ b/docs/src/storage-provider-cli/client/index.md @@ -13,7 +13,7 @@ More information available on the [`wallet`](./wallet.md) page. The `info` command retrieves information about the storage provider it connects to. ```bash -$ polka-storage-provider-client info --rpc-server-address "http://127.0.0.1:8000" +$ polka-storage-provider-client info --rpc-server-url "http://127.0.0.1:8000" { "start_time": "2024-11-06T11:29:06.058967136Z", "address": "5FLSigC9HGRKVhB9FiEo4Y3koPsNmBmLJbpXg2mp1hXcS59Y", diff --git a/docs/src/storage-provider-cli/client/proofs.md b/docs/src/storage-provider-cli/client/proofs.md index 366765cb4..4edb9130c 100644 --- a/docs/src/storage-provider-cli/client/proofs.md +++ b/docs/src/storage-provider-cli/client/proofs.md @@ -1,19 +1,15 @@ # `proofs` - - The following subcommands are contained under `proofs`. +> These are advanced commands and only useful for demo purposes. +> This functionality is covered in the server by the [pipeline](../../architecture/polka-storage-provider-server.md#sealing-pipeline). + | Name | Description | | ---------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | | `calculate-piece-commitment` | Calculate a piece commitment for the provided data stored at the a given path | | `porep-params` | Generates PoRep verifying key and proving parameters for zk-SNARK workflows (prove commit) | -| `porep` | Generates PoRep for a piece file. Takes a piece file (in a CARv2 archive, unpadded), puts it into a sector (temp file), seals and proves it | | `post-params` | Generates PoSt verifying key and proving parameters for zk-SNARK workflows (submit windowed PoSt) | +| `porep` | Generates PoRep for a piece file. Takes a piece file (in a CARv2 archive, unpadded), puts it into a sector (temp file), seals and proves it | | `post` | Creates a PoSt for a single sector | - -# `porep-params` - - -# `post-params` \ No newline at end of file diff --git a/docs/src/storage-provider-cli/client/wallet.md b/docs/src/storage-provider-cli/client/wallet.md index a255b58ee..08a355ce4 100644 --- a/docs/src/storage-provider-cli/client/wallet.md +++ b/docs/src/storage-provider-cli/client/wallet.md @@ -30,7 +30,7 @@ Keys shown on this page are, by default, not secure! Do not use them in producti Generate a new random key to interact with the Polka Storage parachain: ```bash -> polka-storage-provider wallet generate +> polka-storage-provider-client wallet generate Secret phrase: offer payment boost boy manage car asset lock cousin mountain vehicle setup Network ID: substrate Secret seed: 0xfe36ee692552b0ce54de06ce4f5cc152fe2fa808cb40f58c81168bc1237208bb @@ -43,7 +43,7 @@ Secret phrase: offer payment boost boy manage car asset lock cousin mounta The password may be added interactively, using `--password-interactive` flag: ```bash -> polka-storage-provider wallet generate --password-interactive +> polka-storage-provider-client wallet generate --password-interactive Key password: