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

docs: Add instructions to configure TEE Paratime Client Node #915

Merged
merged 1 commit into from
Aug 29, 2024
Merged
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
49 changes: 49 additions & 0 deletions docs/node/run-your-node/paratime-client-node.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -216,6 +216,55 @@ accessible on the internet (for `TCP` and `UDP` traffic).

:::

## Configuring TEE Paratime Client Node
kostko marked this conversation as resolved.
Show resolved Hide resolved

If your node requires the ability to issue queries that can access confidential
data, start by following the [Configuration](#configuration) section to create
the `/node/etc/config.yml` file. Once the file is set up, add the following
content to the `runtime` part within the `/node/etc/config.yml` file:

```yaml
# ... sections not relevant are omitted ...
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
```

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

* `{{ runtime_orc_path }}`: Path to the
[ParaTime bundle](paratime-client-node.mdx#the-paratime-bundle) of the form
`/node/runtimes/foo-paratime.orc`.

## Enabling Expensive Queries

In case you need to issue runtime queries that may require more resources to
compute (e.g. when running a Web3 Gateway), you need to configure the following
in your node's `/node/etc/config.yml` file:

```yaml
# ... sections not relevant are omitted ...
runtime:
paths:
- {{ runtime_orc_path }}
environment: sgx
config:
{{ runtime_id }}:
estimate_gas_by_simulating_contracts: true
allowed_queries:
- all_expensive: true
```

* `{{ runtime_id}}`: You can find the `runtime_id` in the Network Parameters
chapter ([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`.

## Starting the Oasis Node

You can start the node by running the following command:
Expand Down