Oasis Protocol

https://docs.oasis.io/llms.txt
Admin
Oasis Protocol is a privacy-focused blockchain platform offering confidential smart contracts via...
Tokens:597,891
Snippets:4,106
Trust Score:7.8
Update:1 month ago
Show doc for...
Tokens:
Raw
### Example Prompt: Fetch Oasis Sapphire Quickstart Docs

Source: https://docs.oasis.io/build/tools/llms

Example prompt for using Context7 MCP to fetch Oasis Sapphire quickstart docs. Include the library ID to ensure complete documentation.

```text
Use context7 MCP to fetch Oasis Sapphire quickstart docs.Use library ID: llmstxt/oasis_io_llms_txt
```

--------------------------------

### Prompt to fetch Oasis Sapphire quickstart docs

Source: https://docs.oasis.io/build/tools/llms

Example prompt for fetching Oasis Sapphire quickstart documentation via Context7. Use this prompt after configuring the MCP server.

```text
Use context7 MCP to fetch Oasis Sapphire quickstart docs.
Use library ID: llmstxt/oasis_io_llms_txt
```

--------------------------------

### Install partition and QEMU tools (Debian-based)

Source: https://docs.oasis.io/build/rofl/workflow/prerequisites

Installs tools for creating and encrypting partitions and QEMU on Debian-based Linux. Required for the advanced native setup.

```shell
sudo apt install squashfs-tools cryptsetup-bin qemu-utils
```

--------------------------------

### Run Playwright example tests

Source: https://docs.oasis.io/build/sapphire/develop/dappwright

Run the example tests after a successful installation to verify that Playwright is set up correctly.

```shell
npx playwright test
```

--------------------------------

### Example Prompt: Implement Encrypted Events on Sapphire

Source: https://docs.oasis.io/build/tools/llms

Example prompt for using Context7 MCP to get guidance on implementing encrypted events on Sapphire. Include the library ID for complete documentation.

```text
Using context7, show me how to implement encrypted events on Sapphire.Use library ID: llmstxt/oasis_io_llms_txt
```

--------------------------------

### Install RainbowKit and Sapphire dependencies with pnpm

Source: https://docs.oasis.io/build/sapphire/develop/browser

Use pnpm to install the same dependencies as the npm example.

```shell
pnpm add @rainbow-me/rainbowkit wagmi@2.x viem@2.x @tanstack/react-query @oasisprotocol/sapphire-wagmi-v2
```

--------------------------------

### Install Go 1.26.3 with go install and go1.26.3 download

Source: https://docs.oasis.io/build/tools/build-paratime/prerequisites

Optional: required for the Go Client SDK. At least Go 1.26.3 is required. Ensure $GOPATH/bin is in your PATH, then run these commands to install the desired Go version.

```bash
go install golang.org/dl/go1.26.3@latest
go1.26.3 download
```

--------------------------------

### Install RainbowKit and Sapphire dependencies with Yarn

Source: https://docs.oasis.io/build/sapphire/develop/browser

Use Yarn to install the same dependencies as the npm example.

```shell
yarn add @rainbow-me/rainbowkit wagmi@2.x viem@2.x @tanstack/react-query @oasisprotocol/sapphire-wagmi-v2
```

--------------------------------

### Install @oasisprotocol/sapphire-viem-v2

Source: https://docs.oasis.io/build/sapphire/develop/browser

Install the @oasisprotocol/sapphire-viem-v2 library and viem@2.x using npm, pnpm, or Yarn.

```shell
npm install @oasisprotocol/sapphire-viem-v2 viem@2.x
```

```shell
pnpm add @oasisprotocol/sapphire-viem-v2 viem@2.x
```

```shell
yarn add @oasisprotocol/sapphire-viem-v2 viem@2.x
```

--------------------------------

### Install protoc-gen-go to /usr/local/bin

Source: https://docs.oasis.io/core/development-setup/prerequisites

Alternative installation of protoc-gen-go v1.21.0 to /usr/local/bin when $GOPATH/bin is not in PATH. Requires sudo.

```shell
sudo GOBIN=/usr/local/bin ${OASIS_GO:-go} install google.golang.org/protobuf/cmd/protoc-gen-go@v1.21.0
```

--------------------------------

### Build and install Bubblewrap from source

Source: https://docs.oasis.io/node/run-your-node/paratime-node

Build and install Bubblewrap from source for other distributions.

```bash
tar -xf bubblewrap-0.4.1.tar.xz
cd bubblewrap-0.4.1
./configure --prefix=/usr
make
sudo make install

```

--------------------------------

### Install All Soldeer Dependencies

Source: https://docs.oasis.io/build/tools/foundry

Alternative to manually installing packages: after copying the foundry.toml contents, run this command to install all dependencies listed in the configuration.

```shell
forge soldeer install
```

--------------------------------

### Start Oasis Node with Config

Source: https://docs.oasis.io/node/run-your-node/archive-node

Starts the Oasis node using the specified configuration file. Run this command to launch the node.

```bash
oasis-node --config /node/etc/config.yml
```

--------------------------------

### Example client output

Source: https://docs.oasis.io/build/tools/build-paratime/minimal-runtime

Example output from running the minimal-runtime-client, showing initial and final balances for Alice and Bob after a transfer of 10 native base units.

```text
level=info ts=2025-06-28T14:08:02.834961397Z caller=test.go:76 module=minimal-runtime-client msg="connecting to local node"
level=info ts=2025-06-28T14:08:02.836059713Z caller=test.go:96 module=minimal-runtime-client msg="dumping initial balances"
=== Balances for oasis1qrec770vrek0a9a5lcrv0zvt22504k68svq7kzve ===
<native>: 1000000000

=== Balances for oasis1qrydpazemvuwtnp3efm7vmfvg3tde044qg6cxwzx ===
<native>: 2000000000

level=info ts=2025-06-28T14:08:02.864348758Z caller=test.go:111 module=minimal-runtime-client msg="performing transfer" nonce=0
level=info ts=2025-06-28T14:08:18.515842571Z caller=test.go:134 module=minimal-runtime-client msg="dumping final balances"
=== Balances for oasis1qrec770vrek0a9a5lcrv0zvt22504k68svq7kzve ===
<native>: 999999990

=== Balances for oasis1qrydpazemvuwtnp3efm7vmfvg3tde044qg6cxwzx ===
<native>: 2000000010
```

--------------------------------

### sapphire-localnet startup output

Source: https://docs.oasis.io/build/tools/localnet

Example output after starting sapphire-localnet. Shows generated test accounts, private keys, HD wallet mnemonic, and the endpoints for GRPC, Web3 RPC, Nexus API, and Explorer. The chain runs in ephemeral mode, so state is lost on restart.

```console
sapphire-localnet 2024-11-29-gite748a1a (oasis-core: 24.3, sapphire-paratime: 0.9.0-testnet, oasis-web3-gateway: 5.1.0)

 * No ROFLs detected.
 * Starting oasis-net-runner with sapphire...
 * Waiting for Postgres to start...
 * Waiting for Oasis node to start.....
 * Waiting for Envoy proxy to start.
 * Starting oasis-web3-gateway...
 * Bootstrapping network (this might take a minute)....
 * Waiting for key manager......
 * Creating database 'nexus'
 * Waiting for Nexus to start.
 * Waiting for Explorer to start.
 * Populating accounts...

Available Accounts
==================
(0) 0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266 (10000 TEST)
(1) 0x70997970C51812dc3A010C7d01b50e0d17dc79C8 (10000 TEST)
(2) 0x3C44CdDdB6a900fa2b585dd299e03d12FA4293BC (10000 TEST)
(3) 0x90F79bf6EB2c4f870365E785982E1f101E93b906 (10000 TEST)
(4) 0x15d34AAf54267DB7D7c367839AAf71A00a2C6A65 (10000 TEST)

Private Keys
==================
(0) 0xac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf4f2ff80
(1) 0x59c6995e998f97a5a0044966f0945389dc9e86dae88c7a8412f4603b6b78690d
(2) 0x5de4111afa1a4b94908f83103eb1f1706367c2e68ca870fc3fb9a804cdab365a
(3) 0x7c852118294e51e653712a81e05800f419141751be58f605c371e15141b007a6
(4) 0x47e179ec197488593b187f80a00eb0da91f1b9d0b13f8733639f19c30a34926a

HD Wallet
==================
Mnemonic:     test test test test test test test test test test test junk
Base HD Path: m/44'/60'/0'/0/%d

WARNING: The chain is running in ephemeral mode. State will be lost after restart!

 * GRPC listening on http://localhost:8544.
 * Web3 RPC listening on http://localhost:8545 and ws://localhost:8546. Chain ID: 0x5afd.
 * Nexus API listening on http://localhost:8547.
 * Localnet Explorer available at http://localhost:8548.
 * Container start-up took 69 seconds, node log level is set to warn.
```

--------------------------------

### Set up Python environment and install python-telegram-bot

Source: https://docs.oasis.io/build/use-cases/tgbot

Sets up a Python virtual environment and installs the python-telegram-bot dependency.

```shell
python -m venv my_env
source my_env/bin/activate
echo python-telegram-bot > requirements.txt
pip install -r requirements.txt
```

--------------------------------

### Expected directory structure after setup

Source: https://docs.oasis.io/build/tools/other-paratimes/cipher/hello-world

Shows the expected directory structure after completing the guide. Cargo.lock is generated on first compilation.

```text
hello-world
├── Cargo.lock           # Dependency tree checksums (generated on first compilation).
├── Cargo.toml           # Rust crate definition.
├── rust-toolchain.toml  # Rust toolchain version configuration.
└── src
    └── lib.rs           # Smart contract source code.
```

--------------------------------

### Storage migration output example

Source: https://docs.oasis.io/node/reference/upgrade-logs/mainnet

Example output after the storage migration to v5 completes. Take note of the displayed state-root and report it to the Foundation, as it needs to be included in the upgrade's new genesis file.

```text
...
- migrating from v4 to v5...
- migrating version 24468...
- migrated root state-root:195cf7a9a103e7300b2bb4e537cb9935cbebd83e448e67aa55433861a6ad7426 -> state-root:cea105a5d701deab935b94af9e8e0c5af5dcdb61c242bf434da9f11aa8d110ba
- migrated root io-root:0850c5a33ee7f45aa92724b7d5f28c9ac9ae8799b88cc5be9773e8aba9526ca7 -> io-root:19713a2b44e1bf868ebee43c36872baa3058870bb890a5e25d1c4cea2622be77
- migrated root io-root:477391131f60ac2c22bce9167c7e3783a13d4fb81fddd2d388b4ead6a586fe52 -> io-root:f29f86d491303c5fd7b3572e97cbd65b7487b6b4ac519623afd161cc2e4678b7
```

--------------------------------

### Install @oasisprotocol/sapphire-paratime

Source: https://docs.oasis.io/build/sapphire/develop/browser

Install the @oasisprotocol/sapphire-paratime library using npm, pnpm, or Yarn. Choose the command for your preferred package manager.

```shell
npm install @oasisprotocol/sapphire-paratime
```

```shell
pnpm add @oasisprotocol/sapphire-paratime
```

```shell
yarn add @oasisprotocol/sapphire-paratime
```

--------------------------------

### Example output of ROFL application creation

Source: https://docs.oasis.io/build/use-cases/price-oracle

Example output from the Oasis CLI after successfully creating a ROFL application on Testnet.

```text
Created ROFL application: rofl1qqn9xndja7e2pnxhttktmecvwzz0yqwxsquqyxdf
```

--------------------------------

### Start runtime binary in src/main.rs

Source: https://docs.oasis.io/build/tools/build-paratime/minimal-runtime

Boilerplate in src/main.rs that starts the runtime binary so it can be loaded by an Oasis Node.

```rust
use oasis_runtime_sdk::Runtime;

fn main() {
    minimal_runtime::Runtime::start();
}
```

--------------------------------

### Example machine show output

Source: https://docs.oasis.io/build/use-cases/trustless-agent

Example output from `oasis rofl machine show` showing the proxy URL where the agent is accessible.

```text
Proxy:
  Domain: m1058.opf-testnet-rofl-25.rofl.app
  Ports from compose file:
    3000 (elizaos): https://p3000.m1058.opf-testnet-rofl-25.rofl.app
```

--------------------------------

### Install @oasislabs/opengsn-cli with npm

Source: https://docs.oasis.io/build/sapphire/develop/gasless

Initialize a new npm project and install the Oasis fork of the GSN CLI as a dev dependency.

```shell
npm init
npm install -D @oasislabs/opengsn-cli
```

--------------------------------

### Example rustup show output

Source: https://docs.oasis.io/build/tools/other-paratimes/cipher/prerequisites

Example output from rustup show, showing the active toolchain and its rustc version.

```text
rustc 1.65.0-nightly (c0941dfb5 2022-08-21)
```

--------------------------------

### Install Go 1.26.3 with rustup

Source: https://docs.oasis.io/core/development-setup/prerequisites

Installs a specific Go version (1.26.3) using the go command from rustup. Run this in an Oasis Core checkout to set up the required Go toolchain.

```bash
go install golang.org/dl/go1.26.3@latestgo1.26.3 download
```

--------------------------------

### Install @oasislabs/opengsn-cli with pnpm

Source: https://docs.oasis.io/build/sapphire/develop/gasless

Initialize a new pnpm project and install the Oasis fork of the GSN CLI as a dev dependency.

```shell
pnpm init
pnpm add -D @oasislabs/opengsn-cli
```

--------------------------------

### Configure foundry.toml for Sapphire

Source: https://docs.oasis.io/build/tools/foundry

Example foundry.toml configuration after installing the Sapphire packages. The ffi = true setting enables vm.ffi() for calling rust bindings with precompile and decryption logic, and the dependencies section lists the required Soldeer packages.

```toml
[profile.default]
src = "src"
out = "out"
libs = ["lib", "dependencies"]
// highlight-start
ffi = true

[dependencies]
"@oasisprotocol-sapphire-contracts" = "0.2.14"
"@oasisprotocol-sapphire-foundry" = "0.1.1"
// highlight-end
```

--------------------------------

### Install jemalloc 5.2.1

Source: https://docs.oasis.io/core/development-setup/prerequisites

Downloads, verifies, and installs jemalloc 5.2.1 with the 'je_' prefix and reproducible build flags. Must be installed to the default /usr/local prefix because upstream hardcodes its path.

```shell
JEMALLOC_VERSION=5.2.1JEMALLOC_CHECKSUM=34330e5ce276099e2e8950d9335db5a875689a4c6a56751ef3b1d8c537f887f6JEMALLOC_GITHUB=https://github.com/jemalloc/jemalloc/releases/download/pushd $(mktemp -d)wget \  -O jemalloc.tar.bz2 \  "${JEMALLOC_GITHUB}/${JEMALLOC_VERSION}/jemalloc-${JEMALLOC_VERSION}.tar.bz2"# Ensure checksum matches.echo "${JEMALLOC_CHECKSUM} jemalloc.tar.bz2" | sha256sum -ctar -xf jemalloc.tar.bz2cd jemalloc-${JEMALLOC_VERSION}# Ensure reproducible jemalloc build.# https://reproducible-builds.org/docs/build-path/EXTRA_CXXFLAGS=-ffile-prefix-map=$(pwd -L)=. \  EXTRA_CFLAGS=-ffile-prefix-map=$(pwd -L)=. \  ./configure \    --with-jemalloc-prefix='je_' \    --with-malloc-conf='background_thread:true,metadata_thp:auto'makesudo make installpopd
```

--------------------------------

### Compile Oracle contract with Hardhat

Source: https://docs.oasis.io/build/use-cases/price-oracle

Install dependencies and compile the smart contract using Hardhat. Run these commands in the oracle folder from the example project.

```shell
cd oracle
npm install
npx hardhat compile
```

--------------------------------

### Install @oasisprotocol/sapphire-wagmi-v2

Source: https://docs.oasis.io/build/sapphire/develop/browser

Install the @oasisprotocol/sapphire-wagmi-v2 library along with wagmi@2.x and viem@2.x using npm, pnpm, or Yarn.

```shell
npm install @oasisprotocol/sapphire-wagmi-v2 wagmi@2.x viem@2.x
```

```shell
pnpm add @oasisprotocol/sapphire-wagmi-v2 wagmi@2.x viem@2.x
```

```shell
yarn add @oasisprotocol/sapphire-wagmi-v2 wagmi@2.x viem@2.x
```

--------------------------------

### Show and install Rust toolchain with rustup show

Source: https://docs.oasis.io/build/tools/build-paratime/prerequisites

Run this in your project directory to automatically install the appropriate Rust toolchain specified in rust-toolchain.toml. The output shows the active toolchain, e.g., nightly-2025-05-09-x86_64-unknown-linux-gnu.

```bash
rustup show
```

```text
...active toolchain----------------nightly-2025-05-09-x86_64-unknown-linux-gnu (overridden by '/code/rust-toolchain.toml')rustc 1.88.0-nightly (50aa04180 2025-05-08)
```

--------------------------------

### Example output of oasis account show

Source: https://docs.oasis.io/node/run-your-node/paratime-node

Example output from the `oasis account show` command, showing consensus layer and ParaTime balances, delegations, and allowances. This is an example for Testnet.

```text
Address: oasis1qrec770vrek0a9a5lcrv0zvt22504k68svq7kzve
Nonce: 33

=== CONSENSUS LAYER (testnet) ===
  Total: 972.898210067 TEST
  Available: 951.169098086 TEST

  Active Delegations from this Account:
    Total: 16.296833986 TEST

    Delegations:
      - To:     oasis1qz2tg4hsatlxfaf8yut9gxgv8990ujaz4sldgmzx
        Amount: 16.296833986 TEST (15000000000 shares)
  Debonding Delegations from this Account:
    Total: 5.432277995 TEST

    Delegations:
      - To:       oasis1qz2tg4hsatlxfaf8yut9gxgv8990ujaz4sldgmzx
        Amount:   5.432277995 TEST (5432277995 shares)
        End Time: epoch 26558

  Allowances for this Account:
    Total: 269.5000002 TEST
    Allowances:
      - Beneficiary: oasis1qqczuf3x6glkgjuf0xgtcpjjw95r3crf7y2323xd
        Amount:      269.5 TEST
      - Beneficiary: oasis1qrydpazemvuwtnp3efm7vmfvg3tde044qg6cxwzx
        Amount:      0.0000002 TEST

=== sapphire PARATIME ===
Balances for all denominations:
  6.9995378 TEST
```

--------------------------------

### Install golangci-lint

Source: https://docs.oasis.io/core/development-setup/prerequisites

Installs golangci-lint, required for automated code linting (make lint) when changing Go code.

```bash
curl -sSfL \
https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh \
 | sh -s -- -b $(${OASIS_GO:-go} env GOPATH)/bin v2.12.2
```

--------------------------------

### Install and verify Oasis CLI on Linux with Homebrew

Source: https://docs.oasis.io/build/tools/cli/setup

Install the Oasis CLI on Linux via Homebrew, then verify the installation by checking the version.

```shell
brew install oasis
```

```shell
oasis --version
```

--------------------------------

### Example output of orc show

Source: https://docs.oasis.io/build/tools/build-paratime/reproducibility

Example output of `orc show bundle.orc` showing the bundle content including the signed SGX SIGSTRUCT and verified digests.

```text
Bundle:         /path/to/bundle.orc
Name:           my-paratime
Runtime ID:     000000000000000000000000000000000000000000000000a6d1e3ebf60dff6c
Version:        0.1.1
Executable:     runtime.elf
SGXS:           runtime.sgx
SGXS MRENCLAVE: a68535bda1574a5e15dfb155c26e39bd404e9991a4d98010581a35d053011340
SGXS signature: runtime.sgx.sig
SGXS SIGSTRUCT: 
  Build date:       2022-07-14 00:00:00 +0000 UTC
  MiscSelect:       00000000
  MiscSelect mask:  FFFFFFFF
  Attributes flags: 0000000000000004
    - 64-bit mode
  Attributes XFRM:  0000000000000003
  Attributes mask:  FFFFFFFFFFFFFFFD FFFFFFFFFFFFFFFC
  MRENCLAVE:        a68535bda1574a5e15dfb155c26e39bd404e9991a4d98010581a35d053011340
  ISV product ID:   0
  ISV SVN:          0
Digests: 
  runtime.sgx.sig => 3c0daea89dfdb3d0381147dec3e041a596617f686afa9b28436ca17980dafee4
  runtime.elf => a96397fc309bc2116802315c0341a2a9f6f21935d79a3f56d71b3e4d6f6d9302
  runtime.sgx => b96ff3ae9c73646459b7e8dc1d096838720a7c62707affc1800967cbee99b28b
```

--------------------------------

### Install @oasislabs/opengsn-cli with Yarn

Source: https://docs.oasis.io/build/sapphire/develop/gasless

Initialize a new Yarn project and install the Oasis fork of the GSN CLI as a dev dependency.

```shell
yarn init
yarn add --dev @oasislabs/opengsn-cli
```

--------------------------------

### Example ParaTime deployment record

Source: https://docs.oasis.io/node/run-your-node/maintenance/handling-network-upgrades

Example output from the previous command, showing the deployment records for Emerald ParaTime on Testnet. It lists versions and the epochs from which they are valid.

```json
[
  {
    "version": {
      "major": 7,
      "minor": 1
    },
    "valid_from": 14320
  },
  {
    "version": {
      "major": 8
    },
    "valid_from": 15056
  }
]
```

--------------------------------

### Go Client Example

Source: https://docs.oasis.io/core/oasis-node/rpc

Example of using the Go gRPC client for the consensus service to submit a transaction.

```APIDOC
## Go Client Example

### Description
Example of using the Go gRPC client for the consensus service to submit a transaction.

### Method
N/A (Example)

### Endpoint
N/A

### Parameters
None

### Request Example
golang
import (
    // ...
    consensus "github.com/oasisprotocol/oasis-core/go/consensus/api"
)

// ...

cc := consensus.NewConsensusClient(conn)
err := cc.SubmitTx(ctx, &tx)


### Response
N/A
```

--------------------------------

### Install protoc-gen-go v1.21.0

Source: https://docs.oasis.io/core/development-setup/prerequisites

Installs protoc-gen-go v1.21.0. Only needed when modifying protobuf definitions used by Go; the repository already contains generated files.

```shell
${OASIS_GO:-go} install google.golang.org/protobuf/cmd/protoc-gen-go@v1.21.0
```

--------------------------------

### Manually install Oasis CLI on Windows

Source: https://docs.oasis.io/build/tools/cli/setup

Manual installation steps for the Oasis CLI on Windows: create a directory on PATH, copy oasis.exe there, and verify.

```powershell
New-Item -ItemType Directory -Force "$env:USERPROFILE\bin"
Copy-Item .\oasis.exe "$env:USERPROFILE\bin\"
```

```powershell
oasis --version
```

--------------------------------

### Download and install jemalloc 5.2.1

Source: https://docs.oasis.io/core/development-setup/prerequisites

Downloads and installs jemalloc 5.2.1 with the required 'je_' prefix and reproducible build flags. Must be installed to the default /usr/local prefix because upstream hardcodes its path; alternatively set OASIS_BADGER_NO_JEMALLOC=1 when building oasis-node to skip jemalloc.

```bash
JEMALLOC_VERSION=5.2.1
JEMALLOC_CHECKSUM=34330e5ce276099e2e8950d9335db5a875689a4c6a56751ef3b1d8c537f887f6
JEMALLOC_GITHUB=https://github.com/jemalloc/jemalloc/releases/download/
pushd $(mktemp -d)
wget \
  -O jemalloc.tar.bz2 \
  "${JEMALLOC_GITHUB}/${JEMALLOC_VERSION}/jemalloc-${JEMALLOC_VERSION}.tar.bz2"
# Ensure checksum matches.
echo "${JEMALLOC_CHECKSUM} jemalloc.tar.bz2" | sha256sum -c
tar -xf jemalloc.tar.bz2
cd jemalloc-${JEMALLOC_VERSION}
# Ensure reproducible jemalloc build.
# https://reproducible-builds.org/docs/build-path/
EXTRA_CXXFLAGS=-ffile-prefix-map=$(pwd -L)=. \
  EXTRA_CFLAGS=-ffile-prefix-map=$(pwd -L)=. \
  ./configure \
    --with-jemalloc-prefix='je_' \
    --with-malloc-conf='background_thread:true,metadata_thp:auto'
make
sudo make install
popd
```

--------------------------------

### Install Fish completion permanently

Source: https://docs.oasis.io/build/tools/cli/setup

Install Fish completion permanently by writing the completion script to ~/.config/fish/completions/oasis.fish.

```shell
oasis completion fish > ~/.config/fish/completions/oasis.fish
```

--------------------------------

### unmnemonic interactive prompt example

Source: https://docs.oasis.io/general/manage-tokens/faq

Example interactive session of the unmnemonic tool using the Bitpie algorithm, a 12-word mnemonic, wallet index 0, and writing keys to disk. The output shows the generated address and the private key file name.

```text
  unmnemonic - Recover Oasis Network signing keys from mnemonics

? Which algorithm does your wallet use Bitpie
? How many words is your mnemonic 12
? Enter word 1 *****
? Enter word 2 ******
? Enter word 3 ******
? Enter word 4 *******
? Enter word 5 *****
? Enter word 6 *******
? Enter word 7 *******
? Enter word 8 ****
? Enter word 9 *****
? Enter word 10 ******
? Enter word 11 *****
? Enter word 12 ******
? Wallet index(es) (comma separated) 0
 Index[0]: oasis1qp8d9kuduq0zutuatjsgltpugxvl38cuaq3gzkmn
? Write the keys to disk Yes
? Output directory /home/user/unmnemonic/wallet-export-2023-05-01
 Index[0]: oasis1qp8d9kuduq0zutuatjsgltpugxvl38cuaq3gzkmn.private.pem - done
Done writing wallet keys to disk, goodbye.
```

--------------------------------

### Install ethers v6 and @oasisprotocol/sapphire-ethers-v6

Source: https://docs.oasis.io/build/sapphire/develop/browser

Install ethers v6 and @oasisprotocol/sapphire-ethers-v6 using npm, pnpm, or Yarn. Choose the command for your preferred package manager.

```shell
npm install 'ethers@6.x' '@oasisprotocol/sapphire-ethers-v6'
```

```shell
pnpm add 'ethers@6.x' '@oasisprotocol/sapphire-ethers-v6'
```

```shell
yarn add 'ethers@6.x' '@oasisprotocol/sapphire-ethers-v6'
```

--------------------------------

### Example proxy output

Source: https://docs.oasis.io/build/rofl/features/proxy

Example output from `oasis rofl machine show` showing the Proxy section with the public URL for each published port.

```text
Proxy:
  Domain: m602.test-proxy-b.rofl.app
  Ports from compose file:
    5678 (frontend): https://p5678.m602.test-proxy-b.rofl.app
```

--------------------------------

### Example Output of Staking Account List

Source: https://docs.oasis.io/core/development-setup/single-validator-node-network

Example output from the stake list command showing account addresses.

```text
oasis1qzzd6khm3acqskpxlk9vd5044cmmcce78y5l6000
oasis1qz3xllj0kktskjzlk0qacadgwpfe8v7sy5kztvly
oasis1qrh4wqfknrlvv7whjm7mjsjlvka2h35ply289pp2
```

--------------------------------

### New configuration example

Source: https://docs.oasis.io/node/reference/upgrade-logs/mainnet

Shows the new configuration format using runtime.mode and a list of .orc files in runtime.paths.

```yaml
runtime:
  mode: compute
  paths:
    - /path/to/runtime.orc

worker:
  # ... other settings omitted ...

  p2p:
    port: 12346
    addresses:
      - "xx.yy.zz.vv:12346"
```

--------------------------------

### Install Foundry with Foundryup

Source: https://docs.oasis.io/build/tools/foundry

Installs Foundry via Foundryup and updates the shell environment. Run these commands in a terminal to set up the Foundry toolchain.

```shell
curl -L https://foundry.paradigm.xyz | bash
foundryup
source ~/.bashrc
```

--------------------------------

### Previous configuration example

Source: https://docs.oasis.io/node/reference/upgrade-logs/mainnet

Shows the old configuration format with runtime.supported, runtime.paths, and separate worker settings for storage, compute, client, and p2p.

```yaml
runtime:
  supported:
    - "000000000000000000000000000000000000000000000000000000000000beef"

  paths:
    "000000000000000000000000000000000000000000000000000000000000beef": /path/to/runtime

worker:
  # ... other settings omitted ...

  storage:
    enabled: true

  compute:
    enabled: true

  client:
    port: 12345
    addresses:
      - "xx.yy.zz.vv:12345"

  p2p:
    enabled: true
    port: 12346
    addresses:
      - "xx.yy.zz.vv:12346"
```

--------------------------------

### Example node address output

Source: https://docs.oasis.io/node/run-your-node/rofl-node

Example output of the 'oasis-node identity show-address' command. Use this address to fund the node on Sapphire.

```text
oasis1qp6tl30ljsrrqnw2awxxu2mtxk0qxyy2nymtsy90
```

--------------------------------

### Install ledger-wallets-udev package on Debian/Ubuntu

Source: https://docs.oasis.io/general/manage-tokens/faq

Run this command as a normal user to install the 'ledger-wallets-udev' package, which enables access to Ledger devices for all users in the 'udev' group.

```shell
sudo apt install ledger-wallets-udev
```

--------------------------------

### Get Metadata Response

Source: https://docs.oasis.io/build/rofl/features/appd

Example response for the GET /rofl/v1/metadata endpoint, showing the key-value pairs returned by the replica metadata retrieval.

```json
{
  "key_fingerprint": "a54027bff15a8726",
  "version": "1.0.0"
}
```

--------------------------------

### Install gofumpt and goimports

Source: https://docs.oasis.io/core/development-setup/prerequisites

Installs gofumpt and goimports, required for automated code formatting (make fmt) when changing Go code.

```bash
${OASIS_GO:-go} install mvdan.cc/gofumpt@v0.8.0
${OASIS_GO:-go} install golang.org/x/tools/cmd/goimports@v0.36.0
```

--------------------------------

### Install @oasisprotocol/sapphire-hardhat

Source: https://docs.oasis.io/build/sapphire/develop/testing

Install the @oasisprotocol/sapphire-hardhat package using npm, pnpm, or Yarn. This provider automatically encrypts transactions in a Hardhat setup.

```shell
npm install -D @oasisprotocol/sapphire-hardhat
```

```shell
pnpm add -D @oasisprotocol/sapphire-hardhat
```

```shell
yarn add --dev @oasisprotocol/sapphire-hardhat
```

--------------------------------

### Create entity and node directories with correct permissions

Source: https://docs.oasis.io/node/run-your-node/troubleshooting

Initialize the entity and node directories with permissions `700` using `mkdir --mode 700 --parents {entity,node}`.

```bash
mkdir --mode 700 --parents {entity,node}
```

--------------------------------

### Manually install Oasis CLI on Linux

Source: https://docs.oasis.io/build/tools/cli/setup

Manual installation steps for the Oasis CLI on Linux: add ~/.local/bin to PATH, extract the downloaded archive, move the binary, and verify.

```shell
echo 'export PATH="$HOME/.local/bin:$PATH"' >> ~/.bashrc
source ~/.bashrc
mkdir -p ~/.local/bin
```

```shell
cd ~/Downloads
tar -xzf oasis_cli_X.Y.Z_linux_amd64.tar.gz   # adjust version and architecture
```

```shell
mv oasis ~/.local/bin/
```

```shell
oasis --version
```

--------------------------------

### Output of oasis rofl secret get MY_SECRET

Source: https://docs.oasis.io/build/tools/cli/rofl

Example output of the `oasis rofl secret get MY_SECRET` command, showing the secret name and size.

```text
Name:        MY_SECRET
Size:        156 bytes
```

--------------------------------

### Create and test an Eliza agent with ElizaOS CLI

Source: https://docs.oasis.io/build/use-cases/trustless-agent

Initializes a new Eliza project with the ElizaOS CLI, selects the Pqlite database and OpenAI model, then starts the agent locally to verify it runs before deploying to ROFL.

```bash
# Install bun and ElizaOS CLI
bun --version || curl -fsSL https://bun.sh/install | bash
bun install -g @elizaos/cli

# Create and configure the agent
elizaos create -t project rofl-eliza

# 1) Select Pqlite database
# 2) Select the OpenAI model and enter your OpenAI key

# Test the agent locally
cd rofl-eliza
elizaos start

# Visiting http://localhost:3000 with your browser should open Eliza UI
```

--------------------------------

### Output of oasis rofl public-var get API_URL

Source: https://docs.oasis.io/build/tools/cli/rofl

Example output of the `oasis rofl public-var get API_URL` command, showing the variable name, value, and size.

```text
Name:        API_URL
Value:       https://api.example.com
Size:        23 bytes
```

--------------------------------

### Install TDX quote generation service and QEMU

Source: https://docs.oasis.io/node/run-your-node/prerequisites/set-up-tee

Installs the tdx-qgs package from Intel's SGX APT repository and QEMU utilities for running guest virtual machines. Requires a working SGX environment and Ubuntu 26.04 or newer.

```shell
sudo apt install tdx-qgs qemu-utils qemu-system-x86
```

--------------------------------

### Expected output when network starts

Source: https://docs.oasis.io/core/development-setup/oasis-net-runner

Expected log output after the network starts, indicating that the network is ready and the client node socket is available at the given path.

```text
level=info module=oasis/net-runner caller=oasis.go:319 ts=2019-10-03T10:47:30.776566482Z msg="network started"level=info module=net-runner caller=root.go:145 ts=2019-10-03T10:47:30.77662061Z msg="client node socket available" path=/tmp/oasis-net-runner530668299/net-runner/network/client-0/internal.sock
```

--------------------------------

### Show genesis init help

Source: https://docs.oasis.io/core/oasis-node/cli

Displays the full list of parameters for the genesis init command.

```sh
oasis-node genesis init --help
```

--------------------------------

### Install Zsh completion permanently

Source: https://docs.oasis.io/build/tools/cli/setup

Install Zsh completion permanently by writing the completion script to the first fpath directory as _oasis. Start a new shell for changes to take effect.

```shell
oasis completion zsh > "${fpath[1]}/_oasis"
```

--------------------------------

### Initialize a ROFL app with `oasis rofl init`

Source: https://docs.oasis.io/build/rofl/workflow/init

Run this command to create a new ROFL app directory and initialize a ROFL manifest file. By default, a TDX container-based flavor is used; use the `--kind` parameter to select a different flavor.

```shell
oasis rofl init my-app
```

--------------------------------

### Install @oasisprotocol/sapphire-contracts with npm, pnpm, or Yarn

Source: https://docs.oasis.io/build/opl/opl-sdk

Install the @oasisprotocol/sapphire-contracts package using npm, pnpm, or Yarn. Required before importing OPL.sol in your Hardhat project.

```shell
npm install @oasisprotocol/sapphire-contracts
```

```shell
pnpm add @oasisprotocol/sapphire-contracts
```

```shell
yarn add @oasisprotocol/sapphire-contracts
```

--------------------------------

### Install and run TDX system report debug tool

Source: https://docs.oasis.io/node/run-your-node/prerequisites/set-up-tee

Installs msr-tools and clones the Canonical TDX repository, then runs the system-report.sh script to diagnose TDX setup issues. Output shows MSR values and expected values.

```shell
apt install msr-tools
git clone https://github.com/canonical/tdx && ./tdx/system-report.sh
```

```text
### Model specific registers (MSRs)
MK_TME_ENABLED bit: 1 (expected value: 1)
SEAM_RR bit: 1 (expected value: 1)
NUM_TDX_PRIV_KEYS: 20
SGX_AND_MCHECK_STATUS: 0 (expected value: 0)
Production platform: Production (expected value: Production)
```

--------------------------------

### Install golangci-lint v2.12.2

Source: https://docs.oasis.io/core/development-setup/prerequisites

Installs golangci-lint v2.12.2 into the Go bin directory. Required for automated code linting with 'make lint' when changing Go code.

```shell
curl -sSfL \https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh \ | sh -s -- -b $(${OASIS_GO:-go} env GOPATH)/bin v2.12.2
```

--------------------------------

### Build client with go build

Source: https://docs.oasis.io/build/tools/build-paratime/minimal-runtime

Builds the minimal runtime client.

```shell
go build
```

--------------------------------

### Example of an actual Oasis Testnet Key Manager policy

Source: https://docs.oasis.io/node/run-your-node/keymanager-node/signing-key-manager-policy

Example JSON output from the verify_policy command, showing the policy structure with serial, id, enclaves, may_query, and may_replicate fields.

```json
{
  "serial": 8,
  "id": "4000000000000000000000000000000000000000000000004a1a53dff2ae482d",
  "enclaves": {
    "ZhD5ufyc/MReZD1qMSKNCRxnkNiZ3BtxqcYdx4+M0N9AJdq369ofvsxONjdgbgISFND0HG0EIv03iyqLiIGEWQ==": {
      "may_query": {
        "0000000000000000000000000000000000000000000000000000000000000000": [
          "c0SidcKhBx3iuonmtXURnFB+qIVkg+nAiaAozAh16ltAJdq369ofvsxONjdgbgISFND0HG0EIv03iyqLiIGEWQ=="
        ],
        "000000000000000000000000000000000000000000000000a6d1e3ebf60dff6c": [
          "LwbLEQ6dv+R5wv5q5CGRZWiEBWGxgCi/gpphcJFQ5zVAJdq369ofvsxONjdgbgISFND0HG0EIv03iyqLiIGEWQ=="
        ]
      },
      "may_replicate": [
        "jTX8etUcGSQBq3C4WbLlexga7dhQFnwzSJOEmRCPvfRAJdq369ofvsxONjdgbgISFND0HG0EIv03iyqLiIGEWQ=="
      ]
    },
    "jTX8etUcGSQBq3C4WbLlexga7dhQFnwzSJOEmRCPvfRAJdq369ofvsxONjdgbgISFND0HG0EIv03iyqLiIGEWQ==": {
      "may_query": {
        "0000000000000000000000000000000000000000000000000000000000000000": [
          "c0SidcKhBx3iuonmtXURnFB+qIVkg+nAiaAozAh16ltAJdq369ofvsxONjdgbgISFND0HG0EIv03iyqLiIGEWQ=="
        ],
        "000000000000000000000000000000000000000000000000a6d1e3ebf60dff6c": [
          "LwbLEQ6dv+R5wv5q5CGRZWiEBWGxgCi/gpphcJFQ5zVAJdq369ofvsxONjdgbgISFND0HG0EIv03iyqLiIGEWQ=="
        ]
      },
      "may_replicate": []
    }
  }
}
```

--------------------------------

### Install system packages on Fedora 29+

Source: https://docs.oasis.io/core/development-setup/prerequisites

Installs all required system packages (Bubblewrap, GCC, Clang, Protobuf, Make, CMake, pkg-config, OpenSSL, libseccomp) on Fedora 29+ using dnf.

```bash
sudo dnf install bubblewrap gcc gcc-c++ clang-devel clang protobuf-compiler make cmake openssl-devel libseccomp-devel pkg-config
```

--------------------------------

### Example custom domain DNS output

Source: https://docs.oasis.io/build/rofl/features/proxy

Example output from `oasis rofl machine show` showing DNS configuration instructions for a custom domain in terminate-tls mode.

```text
Proxy:
  Domain: m897.opf-testnet-rofl-25.rofl.app
  Ports from compose file:
    5678 (frontend): https://demo.rofl.build
      * Point the A record of your domain to: 131.153.241.25
      * Add a TXT record to your domain:
oasis-rofl-verification=4SKHCn4E2SNDB5tXayQeHZsvH/+kJSNGuQaTAPepYJc=
```

--------------------------------

### Prompt for encrypted events on Sapphire

Source: https://docs.oasis.io/build/tools/llms

Example prompt for getting guidance on implementing encrypted events on Sapphire via Context7. Use this prompt after configuring the MCP server.

```text
Using context7, show me how to implement encrypted events on Sapphire.
Use library ID: llmstxt/oasis_io_llms_txt
```

--------------------------------

### Example output of `oasis paratime show parameters`

Source: https://docs.oasis.io/build/tools/cli/paratime

Example output of `oasis paratime show parameters` for the testnet Sapphire ParaTime, showing ROFL stake thresholds for app creation and provider creation. The output can be formatted as JSON by passing `--format json`.

```text
Network:        testnet
ParaTime:       sapphire

=== ROFL PARAMETERS ===
  Stake thresholds:
    App create: 100.0 TEST


=== ROFL MARKET PARAMETERS ===
  Stake thresholds:
    Provider create: 100.0 TEST

```

--------------------------------

### Initialize Go module for minimal runtime client

Source: https://docs.oasis.io/build/tools/build-paratime/minimal-runtime

Initializes a Go module for the minimal runtime client and fetches dependencies. Run these commands in a new 'tests' directory before creating the test file.

```shell
go mod init example.com/oasisprotocol/minimal-runtime-client
go mod tidy
```

--------------------------------

### Install gofumpt and goimports

Source: https://docs.oasis.io/core/development-setup/prerequisites

Installs gofumpt v0.8.0 and goimports v0.36.0 using the Go toolchain. The ${OASIS_GO:-go} variable defaults to 'go' if OASIS_GO is not set.

```shell
${OASIS_GO:-go} install mvdan.cc/gofumpt@v0.8.0${OASIS_GO:-go} install golang.org/x/tools/cmd/goimports@v0.36.0
```

--------------------------------

### Install RainbowKit and Sapphire dependencies with npm

Source: https://docs.oasis.io/build/sapphire/develop/browser

Use npm to install RainbowKit, Wagmi v2, Viem v2, React Query, and the Sapphire Wagmi v2 package.

```shell
npm install @rainbow-me/rainbowkit wagmi@2.x viem@2.x @tanstack/react-query @oasisprotocol/sapphire-wagmi-v2
```

--------------------------------

### Install release tooling with pip

Source: https://docs.oasis.io/core/release-process

Install Oasis' towncrier fork and Punch 2.0.x using pip. Use a Python virtual environment or a user install if you prefer to avoid system-wide installation.

```bash
pip3 install --upgrade \
  https://github.com/oasisprotocol/towncrier/archive/oasis-master.tar.gz \
  punch.py~=2.0.0
```
Tokens:
Raw