From 5c7e8e76bbfa924029bde446b620dfa9a76beeb8 Mon Sep 17 00:00:00 2001 From: Jernej Kos Date: Thu, 4 Jul 2024 10:18:30 +0200 Subject: [PATCH] docs: Add ROFL --- docs/rofl/README.mdx | 30 ++++++++++++++++++++++++++++++ docs/rofl/app.md | 1 + docs/rofl/prerequisites.md | 1 + docs/rofl/trust-root.md | 1 + external/oasis-sdk | 2 +- sidebarRofl.ts | 14 ++++++++++++++ sidebars.ts | 2 ++ 7 files changed, 50 insertions(+), 1 deletion(-) create mode 100644 docs/rofl/README.mdx create mode 120000 docs/rofl/app.md create mode 120000 docs/rofl/prerequisites.md create mode 120000 docs/rofl/trust-root.md create mode 100644 sidebarRofl.ts diff --git a/docs/rofl/README.mdx b/docs/rofl/README.mdx new file mode 100644 index 0000000000..df44960212 --- /dev/null +++ b/docs/rofl/README.mdx @@ -0,0 +1,30 @@ +--- +description: Build your own ROFL application +--- + +import DocCardList from '@theme/DocCardList'; +import {findSidebarItem} from '@site/src/sidebarUtils'; + +# Build ROFL Application + +Runtime OFf-chain Logic (ROFL) applications are a mechanism to augment the +deterministic on-chain backend with verifiable off-chain applications. These +applications are stateless, have access to the network and can perform expensive +and/or non-deterministic computation. + +ROFL applications run in Trusted Execution Environments (TEEs), similar to the +on-chain confidential runtimes. This enables them to securely authenticate to +the on-chain backend which is handled transparently by the framework. Together +they allow one to implement secure decentralized oracles, bridges, AI agents and +more. + +This chapter will teach you how to build your own ROFL application with +[Oasis Runtime SDK]. + + + +[Oasis Runtime SDK]: + https://github.com/oasisprotocol/oasis-sdk/tree/main/runtime-sdk diff --git a/docs/rofl/app.md b/docs/rofl/app.md new file mode 120000 index 0000000000..50a112030a --- /dev/null +++ b/docs/rofl/app.md @@ -0,0 +1 @@ +../../external/oasis-sdk/docs/rofl/app.md \ No newline at end of file diff --git a/docs/rofl/prerequisites.md b/docs/rofl/prerequisites.md new file mode 120000 index 0000000000..4de79acf45 --- /dev/null +++ b/docs/rofl/prerequisites.md @@ -0,0 +1 @@ +../../external/oasis-sdk/docs/rofl/prerequisites.md \ No newline at end of file diff --git a/docs/rofl/trust-root.md b/docs/rofl/trust-root.md new file mode 120000 index 0000000000..5b666d55c0 --- /dev/null +++ b/docs/rofl/trust-root.md @@ -0,0 +1 @@ +../../external/oasis-sdk/docs/rofl/trust-root.md \ No newline at end of file diff --git a/external/oasis-sdk b/external/oasis-sdk index 385af35781..31cc6623dc 160000 --- a/external/oasis-sdk +++ b/external/oasis-sdk @@ -1 +1 @@ -Subproject commit 385af35781072dbe3d5e29f93951972f8ed71e92 +Subproject commit 31cc6623dcb7429d9195f54591a00676a9b24223 diff --git a/sidebarRofl.ts b/sidebarRofl.ts new file mode 100644 index 0000000000..06add668ed --- /dev/null +++ b/sidebarRofl.ts @@ -0,0 +1,14 @@ +import {SidebarsConfig} from '@docusaurus/plugin-content-docs'; + +export const sidebarROFL: SidebarsConfig = { + rofl: [ + { + type: 'doc', + label: 'Overview', + id: 'rofl/README', + }, + 'rofl/prerequisites', + 'rofl/app', + 'rofl/trust-root', + ], +}; diff --git a/sidebars.ts b/sidebars.ts index dbec4e54fb..0e6781e1a9 100644 --- a/sidebars.ts +++ b/sidebars.ts @@ -7,6 +7,7 @@ import {sidebarGeneral} from './sidebarGeneral'; import {sidebarGetInvolved} from './sidebarGetInvolved'; import {sidebarNode} from './sidebarNode'; import {sidebarParaTime} from './sidebarParatime'; +import {sidebarROFL} from './sidebarRofl'; const sidebars: SidebarsConfig = { ...sidebarAdrs, @@ -16,6 +17,7 @@ const sidebars: SidebarsConfig = { ...sidebarGetInvolved, ...sidebarNode, ...sidebarParaTime, + ...sidebarROFL, }; export default sidebars;