Skip to content

docs/node: Update client node configuration #1124

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs/node: Update client node configuration #1124

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
13 changes: 10 additions & 3 deletions docs/node/run-your-node/paratime-client-node.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -200,14 +200,22 @@ runtime:
# Paths to ParaTime bundles for all of the supported ParaTimes.
Copy link
Contributor

@gw0 gw0 Feb 13, 2025

Choose a reason for hiding this comment

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

Are ROFL runtimes also called ParaTimes? It might be cleaner if we revision this "ParaTime" naming convention and start using the new more meaningful names, "runtime on-chain logic (RONL) (aka ParaTime/chain)" and "runtime off-chain logic (ROFL)".

Copy link
Contributor Author

@peternose peternose Mar 1, 2025

Choose a reason for hiding this comment

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

In the code we are using name runtime for a group of components, one of them being RONL. In the future, the Sapphire runtime should look like this:

  • one RONL component (paratime or runtime in old days),
  • multiple system ROFL components (included in the bundle, auto upgraded together with RONL),
  • custom ROFL components (that talk to RONL and other ROFLs).

paths:
- {{ runtime_orc_path }}
# Configure ParaTimes to run outside of a Trusted Execution Environment.
Copy link
Contributor

@gw0 gw0 Feb 13, 2025

Choose a reason for hiding this comment

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

Is this even needed? If no TEE is specified, it is automatically selected based on availability, with TDX and SGX taking precedence over ELF. If we want to just illustrate how a RONL can be optionally configured, we could show an commented out example? Would it make sense to also show an example of the runtime.runtimes[].config field?

# config:
#   estimate_gas_by_simulating_contracts: true
#   allowed_queries:
#     - all_expensive: true

Copy link
Contributor Author

@peternose peternose Mar 1, 2025

Choose a reason for hiding this comment

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

Ups, missed these comments.

Is this even needed? If no TEE is specified, it is automatically selected based on availability, with TDX and SGX taking precedence over ELF.

No, we don't auto check if the host supports TEE and then run runtime in it. We could implement this in the future. But currently, if runtime want's to run in SGX and your node doesn't support that, it will fail while provisioning the runtime.

runtimes:
- id: {{ runtime_id }}
components:
- id: ronl
tee: none
```

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

* `{{ seed_node_address }}`: The seed node address in the form `ID@IP:port`.
* 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]).
* `{{ runtime_id }}`: Runtime identifier of the ParaTime.
* You can find the runtime identifiers for the current Oasis-supported ParaTimes in the Network Parameters page ([Mainnet], [Testnet]).

:::caution

Expand All @@ -216,7 +224,7 @@ accessible on the internet (for `TCP` and `UDP` traffic).

:::

## Configuring TEE Paratime Client Node
## Configuring TEE ParaTime Client Node

If your node requires the ability to issue queries that can access confidential
data, start by following the [Configuration](#configuration) section to create
Expand All @@ -229,7 +237,6 @@ runtime:
# Paths to ParaTime bundles for all of the supported ParaTimes.
paths:
- {{ runtime_orc_path }}
environment: sgx
sgx_loader: /node/bin/oasis-core-runtime-loader
```

Expand Down