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.

Sign up for GitHub

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

Fix typos #14

Open
wants to merge 7 commits into
base: main
Choose a base branch
from
Open

Fix typos #14

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
d909351
Fix: typos
omahs Jun 15, 2023
7b1ab71
Fix: typo
omahs Jun 15, 2023
1212603
Fix: typo
omahs Jun 15, 2023
568c974
Fix: typos
omahs Jun 15, 2023
685cb41
Fix: typo
omahs Jun 15, 2023
380fdf1
Fix: typo
omahs Jun 15, 2023
2fbb95d
Fix: typo
omahs Jun 15, 2023
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
4 changes: 2 additions & 2 deletions compute-providers/basic-info/confidence-level-and-sgx-function.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ Your confidence level, referred to as the “Tier” in the table below, will ap

The confidence level measures how secure the SGX Enclave execution environment is. It’s determined by the Remote Attestation report from Intel. Among them, `isvEnclaveQuoteStatus` indicates if the platform is vulnerable to some known problems, and `advisoryIDs` indicates the actual affected problems.

Not all the `advisoryIDs` are problematic. Some advisories doesn’t affect Phala’s security assumption, and therefore are whitelisted:
Not all the `advisoryIDs` are problematic. Some advisories don’t affect Phala’s security assumption, and therefore are whitelisted:

* INTEL-SA-00219
* INTEL-SA-00334
Expand All @@ -93,7 +93,7 @@ Tier 1, 2, 3 are considered with the best security level because they are either
* Secret key management: wallet, node KMS, password manager
* Phala Gatekeeper

Tier 4, 5 are considered with reduced security, because these machines requires some configuration fix in the BIOS or BIOS firmware (CONFIGURATION\_NEEDED, CONFIGURATION\_AND\_SW\_HARDENING\_NEEDED), or their microcode or the corresponding BIOS firmware are out-of-date (GROUP\_OUT\_OF\_DATE). Therefore we cannot assume the platform is suitable for highest security scenarios. However it’s still good to run batch processing jobs, apps dealing with ephemeral privacy data, and traditional blockchain apps:
Tier 4, 5 are considered with reduced security, because these machines require some configuration fix in the BIOS or BIOS firmware (CONFIGURATION\_NEEDED, CONFIGURATION\_AND\_SW\_HARDENING\_NEEDED), or their microcode or the corresponding BIOS firmware are out-of-date (GROUP\_OUT\_OF\_DATE). Therefore we cannot assume the platform is suitable for highest security scenarios. However it’s still good to run batch processing jobs, apps dealing with ephemeral privacy data, and traditional blockchain apps:

* Data analysis jobs (e.g. Web3 Analytics)
* On-chain PvP games
Expand Down
2 changes: 1 addition & 1 deletion compute-providers/basic-info/error-summary.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
| WorkerDoesNotExist | The worker is already added to the pool | - |
| WorkerInAnotherPool | The worker is already added to another pool | Remove it from the pool to which the worker is added before if it’s not the pool you want to add the worker to |
| UnauthorizedOperator | The access to a worker is granted by its operator parameter set by register\_worker | Check the config on the mining scripts |
| InsufficientFreeStake | Cannot start mining because there’s no enough free stake | The stake amount you set to the work is more than the free stake amount in the pool. Set a number that is less than the free stake or delegates more PHA in the pool |
| InsufficientFreeStake | Cannot start mining because there’s not enough free stake | The stake amount you set to the work is more than the free stake amount in the pool. Set a number that is less than the free stake or delegates more PHA in the pool |
| WorkersExceedLimit | Failed to add a worker because the number of the workers exceeds the upper limit. | Create another pool or remove the useless worker in this pool (Make sure the worker is stopped and reclaimed before you remove it) |
| CannotRestartWithLessStake | Restarted with a less stake is not allowed in the tokenomic. | - |
| MinerNotReady | Miner is not in Ready state to proceed. | Wait for a 7 days period of Cool-down and reclaim it when the period is finished |
Expand Down
2 changes: 1 addition & 1 deletion compute-providers/basic-info/worker-rewards.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,7 @@ Each individual’s $$V$$ is updated at every block:

When a worker gets a payout $$w(V_t)$$, they will receive the amount immediately in their Phala wallet. The payout follows _**Payout Schedule**_ and cannot exceed the _**Subsidy Budget**_.

Finally, once the worker decides to stop mining, they will wait for a Cooling Down period $\delta$. They will receive an one-time final payout after the cooldown.
Finally, once the worker decides to stop mining, they will wait for a Cooling Down period $\delta$. They will receive a one-time final payout after the cooldown.

| Block number | $t$ | $t+1$ | $\dots$ | $T$ | $\dots$ | $T+\delta$ |
| ------------- | ------------ | ------------- | ------- | ------------ | ------------------------------- | ------------------------ |
Expand Down
2 changes: 1 addition & 1 deletion developers/advanced-topics/run-local-testnet.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ It takes approximately 20 minutes to complete the building process on a laptop e

### Start the local testnet <a href="#start-the-local-testnet" id="start-the-local-testnet"></a>

We have a dedicate set of scripts to get the blockchain to run, checkout out [this page](https://github.com/Phala-Network/phala-blockchain/tree/master/scripts/run) for full details. For simplicity we can start as simple as follows:
We have a dedicated set of scripts to get the blockchain to run, checkout out [this page](https://github.com/Phala-Network/phala-blockchain/tree/master/scripts/run) for full details. For simplicity we can start as simple as follows:

We might want to clean up runtime data to have to clean starting environment, from the root of the `phala-blockchain` project, run this to clean things up:

Expand Down
2 changes: 1 addition & 1 deletion developers/build-on-phat-contract/deploy-contract.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Now that you have created and compiled your `phat_hello` contract, let's deploy
{% tab title="Swanky Phala" %}
> If you have not installed `swanky phala` CLI tool, follow these [steps](../swanky-phala-cli-tool.md) to get started.

Go to your development workspace and ensure that you have updated your `devphase.config.json` file to include the PoC5 Testnet info. Within`networks` , add the following:
Go to your development workspace and ensure that you have updated your `devphase.config.json` file to include the PoC5 Testnet info. Within `networks`, add the following:

```bash
"networks": {
Expand Down
2 changes: 1 addition & 1 deletion developers/support/resource-limits.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
| Maximum code size | The maximum size of the compiled contract code that can be deployed | 2 megabytes | 32 megabytes |
| Maximum ingress requests | The maximum number of simultaneous query requests processed by a single worker | 8 by default | unlimited |
| Request fulfillment timeout | The maximum duration of an in-flight query request | 10 seconds | unlimited |
| Maximum request size | The maximum size of a incoming request (this includes all arguments) | 16 kilobytes | unlimited, streaming is supported |
| Maximum request size | The maximum size of an incoming request (this includes all arguments) | 16 kilobytes | unlimited, streaming is supported |
| Maximum returned value size | The maximum size of the response of a query | 16 kilobytes | unlimited, streaming is supported |
| Maximum query execution time | The maximum amount of time that a single query can execute | 10 seconds | N/A (continuously running) |
| Maximum memory allocated | The maximum amount of memory allocated to your contract during execution | 4 megabytes | 16 MB |
Expand Down
8 changes: 4 additions & 4 deletions developers/swanky-phala-cli-tool.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ Building with `oclif` allows for the `swanky-cli` to be extended through the [pl

### Installation

> _Currently `swanky phala` will only support Ubuntu Linux. Other Linux operating systems are support, but this requires downloading and compiling `phala-node`, `pherry` and `pruntime` binaries locally. Then copy the binaries to the `stacks/` folder._
> _Currently `swanky phala` will only support Ubuntu Linux. Other Linux operating systems are supported, but this requires downloading and compiling `phala-node`, `pherry` and `pruntime` binaries locally. Then copy the binaries to the `stacks/` folder._

#### Install Swanky CLI

Expand Down Expand Up @@ -132,7 +132,7 @@ This will initiate a round of questions to get your Phat Contract template confi

At this moment, `pink` is the only contract language option at this time. `pink` is the Phala `ink` library to support rust-based [ink! language](https://paritytech.github.io/ink/) in Phala’s `pRuntime` workers.

Next you’ll be asked the what contract template to use (`blank`, `http_client`, or `phat_hello` more to come!).
Next you’ll be asked what contract template to use (`blank`, `http_client`, or `phat_hello` more to come!).

```bash
? Which contract template should we use? (Use arrow keys)
Expand Down Expand Up @@ -248,7 +248,7 @@ drwxr-xr-x. 1 hashwarlock hashwarlock 36 Apr 4 16:27 ..
* `pruntime`
* `pherry`

Once verified file are downloaded and there is not an instance running currently, the local testnet will start.
Once verified files are downloaded and there is not an instance running currently, the local testnet will start.

```bash
swanky phala node start
Expand Down Expand Up @@ -344,7 +344,7 @@ Create type bindings for contracts

#### Validate Your Compiled WASM Contract

Sometimes there are difficult to find errors that lie within a succesfully compiled wasm blob. The command `swanky phala contract validate -c [CONTRACT_NAME]` will do a preliminary check to verify if the compiled contract is valid for deployment.
Sometimes there are difficult to find errors that lie within a successfully compiled wasm blob. The command `swanky phala contract validate -c [CONTRACT_NAME]` will do a preliminary check to verify if the compiled contract is valid for deployment.

```
└─[$]> swanky phala contract validate -c phat_hello
Expand Down