Skip to content

Commit

Permalink
docs: Add ROFL
Browse files Browse the repository at this point in the history
  • Loading branch information
kostko committed Aug 20, 2024
1 parent 2983f57 commit b21a190
Show file tree
Hide file tree
Showing 7 changed files with 50 additions and 1 deletion.
30 changes: 30 additions & 0 deletions docs/rofl/README.mdx
Original file line number Diff line number Diff line change
@@ -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].

<DocCardList items={[
findSidebarItem('/rofl/prerequisites'),
findSidebarItem('/rofl/app'),
]} />

[Oasis Runtime SDK]:
https://github.com/oasisprotocol/oasis-sdk/tree/main/runtime-sdk
1 change: 1 addition & 0 deletions docs/rofl/app.md
1 change: 1 addition & 0 deletions docs/rofl/prerequisites.md
1 change: 1 addition & 0 deletions docs/rofl/trust-root.md
2 changes: 1 addition & 1 deletion external/oasis-sdk
Submodule oasis-sdk updated 303 files
14 changes: 14 additions & 0 deletions sidebarRofl.ts
Original file line number Diff line number Diff line change
@@ -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',
],
};
2 changes: 2 additions & 0 deletions sidebars.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand All @@ -16,6 +17,7 @@ const sidebars: SidebarsConfig = {
...sidebarGetInvolved,
...sidebarNode,
...sidebarParaTime,
...sidebarROFL,
};

export default sidebars;

0 comments on commit b21a190

Please sign in to comment.