-
Notifications
You must be signed in to change notification settings - Fork 34
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
3xz1
wants to merge
4
commits into
oasisprotocol:main
Choose a base branch
from
deltaDAO:main
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Update Oasis Docs #739
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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 | ||
|
||
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 | ||
|
||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Missing closing |
||
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 | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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 | ||
|
||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Missing closing |
||
6. Start your Oasis Node. | ||
|
||
[`User` directive]: | ||
https://www.freedesktop.org/software/systemd/man/systemd.exec.html#User= | ||
|
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.