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

Update Oasis Docs #739

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open
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
26 changes: 26 additions & 0 deletions docs/node/run-your-node/paratime-client-node.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -208,6 +208,32 @@ Before using this configuration you should collect the following information to
* You can find the current Oasis Seed Node address in the Network Parameters page ([Mainnet], [Testnet]).
* `{{ runtime_orc_path }}`: Path to the [ParaTime bundle](paratime-client-node.mdx#the-paratime-bundle) of the form `/node/runtimes/foo-paratime.orc`.
* You can find the current Oasis-supported ParaTimes in the Network Parameters page ([Mainnet], [Testnet]).
## Configuring for Confidential States
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
## Configuring for Confidential States
## Configuring for Confidential States


To enable access to confidential states on your ParaTime Client Node using SGX, follow these steps:

1. **Update Runtime Configuration:**
Add the following configuration to your `/node/etc/config.yml` file:

```yaml
runtime:
# Paths to ParaTime bundles for all of the supported ParaTimes.
paths:
- {{ runtime_orc_path }}
environment: sgx
config:
{{ paratime_id }}:
estimate_gas_by_simulating_contracts: true
allowed_queries:
- all_expensive: true
sgx_loader: /node/bin/oasis-core-runtime-loader

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Missing closing ``` ticks?

Before using this configuration you should collect the following information to replace the variables present in the configuration file:.

* `{{ paratime_id}}`: RUNTIME_ID - See runtime identifiers on how to choose a runtime identifier.
* `{{ runtime_orc_path }}`: Path to the [ParaTime bundle](paratime-client-node.mdx#the-paratime-bundle) of the form `/node/runtimes/foo-paratime.orc`.
* You can find the current Oasis-supported ParaTimes in the Network Parameters page ([Mainnet], [Testnet]).


## Starting the Oasis Node

Expand Down
12 changes: 11 additions & 1 deletion docs/node/run-your-node/prerequisites/system-configuration.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -198,7 +198,17 @@ chpst -u oasis oasis-node ...
</TabItem>
</Tabs>

5. Start your Oasis Node.
5. Adding SGX Permissions for ParaTime Node/Client

If you intend to run a ParaTime Node or a ParaTime Client Node and want to enable SGX support, you'll need to ensure that the `oasis` user has the necessary permissions to access SGX resources.

1. **Add `oasis` User to `sgx` Group:**
Ensure that the `oasis` user is added to the `sgx` group to grant it access to SGX resources. You can do this by running:

```bash
sudo usermod -aG sgx oasis

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Missing closing ``` ticks?

6. Start your Oasis Node.

[`User` directive]:
https://www.freedesktop.org/software/systemd/man/systemd.exec.html#User=
Expand Down
Loading