@@ -8,115 +8,55 @@ import {findSidebarItem} from '@site/src/sidebarUtils';
8
8
9
9
# Build on Oasis
10
10
11
- ![ Oasis architectural design including ParaTime and consensus layers] ( ../general/images/architecture/technology_scalability.svg )
11
+ The best way to start learning is by example! If you want to jumpstart
12
+ right into it, check out our use cases that combine TEE and blockchain to
13
+ build trustless distributed apps.
12
14
13
- ## ROFL
15
+ <DocCardList items = { [
16
+ findSidebarItem (' /build/use-cases/price-oracle' ),
17
+ findSidebarItem (' /build/use-cases/tgbot' ),
18
+ ]} />
14
19
15
- Runtime OFfchain Logic (ROFL) enables you to build secure applications running
16
- offchain in a trusted environment (TEE) containers. This is ideal for trusted
17
- oracles, compute-expensive tasks in AI or as a backend for interactive games.
18
- ROFL apps can seamlessly sign transactions running on [ Sapphire] .
20
+ ## The Oasis SDK
19
21
20
- <DocCard item = { findSidebarItem (' /build/rofl/' )} />
21
-
22
- ## Sapphire
23
-
24
- [ Sapphire] is an EVM-compatible Layer 1 blockchain that allows you to
25
- write both confidential and non-confidential smart contracts. The transactions
26
- can also be end-to-end encrypted and stored on the blockchain ledger.
27
-
28
- Sapphire is just one of the ParaTimes running on the Oasis platform. For an
29
- overview of other ParaTimes, refer to the [ Other ParaTimes] chapter.
30
-
31
- <DocCard item = { findSidebarItem (' /build/sapphire/' )} />
32
-
33
- [ Oasis architecture ] : ../general/oasis-network/README.mdx
34
- [ Sapphire ] : https://github.com/oasisprotocol/docs/blob/main/docs/build/sapphire/README.mdx
35
- [ Other ParaTimes ] : ./tools/other-paratimes/README.mdx
36
-
37
- ## Oasis Privacy Layer (OPL)
38
-
39
- In addition to building fully native dApps running on one of the Oasis
40
- ParaTimes, you can also add privacy to your existing dApps running on other,
41
- non-confidential chains, and only use Oasis as a * privacy service* .
42
-
43
- The Oasis team prepared a rich cross-chain toolkit called the
44
- [ ** Oasis Privacy Layer** ] ( opl/README.mdx ) . It consists of solidity precompiles
45
- integrating bridges and wrapping the OpenZeppelin ERC2771 contract on top of
46
- Sapphire, demonstrates best practices for writing confidential smart contracts
47
- and working examples for you to explore and extend.
48
-
49
- <DocCard item = { findSidebarItem (' /build/opl/' )} />
50
-
51
- ## Consensus Network Information
22
+ ![ Oasis architectural design including ParaTime and consensus layers] ( ./images/oasis-sdk.svg )
52
23
53
- ### RPC Endpoints
24
+ ### ROFL-Powered Apps
54
25
55
- :::danger
26
+ [ Runtime off-chain logic (ROFL)] [ rofl ] enables you to wrap applications in
27
+ trusted environment (TEE) containers managed through [ Sapphire] . This
28
+ framework is ideal for deploying provably trusted oracles, compute-expensive
29
+ tasks in AI or a backend for interactive games.
56
30
57
- The RPC endpoint is a ** point of trust** . Beside rate limiting, it can also
58
- perform censorship or even man-in-the-middle attack. If you have security
59
- considerations, we strongly recommend that you [ run your own client
60
- node] [ non-validator-node ] ,
61
-
62
- :::
63
-
64
- [ non-validator-node ] : ../node/run-your-node/non-validator-node.mdx
65
-
66
- Most dApp developers will build dApps on the ParaTime layer (the * compute*
67
- layer) depicted above. For Sapphire and Emerald which are EVM-compatible chains,
68
- those dApps connect directly to an [ EVM-compatible Web3 endpoint] [ web3 ] .
69
- However, if you are building a dApp for Cipher or the one that needs to
70
- perform consensus operations such as the consensus-layer token transfers,
71
- governance transactions, cross-chain ParaTime deposits and withdrawals and
72
- similar, you will need to connect to the one of the endpoints speaking
73
- [ Oasis gRPC] [ grpc ] .
74
-
75
- Public gRPC endpoints (in alphabetic order):
76
-
77
- | Provider | Mainnet URL | Testnet URL |
78
- | ----------| ---------------------| -----------------------------|
79
- | [ Oasis] | ` grpc.oasis.io:443 ` | ` testnet.grpc.oasis.io:443 ` |
80
-
81
- [ Oasis ] : https://oasis.net
82
- [ web3 ] : ../node/web3.mdx
83
- [ grpc ] : ../node/grpc.mdx
84
-
85
- ### Block Explorers
86
-
87
- | Name (Provider) | Mainnet URL | Testnet URL |
88
- | --------------------------| -----------------------------------------------| ---------------------------------------------|
89
- | Oasis Explorer ([ Oasis] ) | https://explorer.oasis.io/mainnet/consensus | https://explorer.oasis.io/testnet/consensus |
90
- | Oasis Scan ([ Bit Cat] ) | https://www.oasisscan.com | https://testnet.oasisscan.com |
91
-
92
- [ Bit Cat ] : https://www.bitcat365.com/
93
-
94
- ### Indexers
31
+ <DocCard item = { findSidebarItem (' /build/rofl/' )} />
95
32
96
- | Name (Provider) | Mainnet URL | Testnet URL | Documentation |
97
- | ------------------------| ----------------------------------------| ----------------------------------------| --------------------------------------------|
98
- | Oasis Nexus ([ Oasis] ) | ` https://nexus.oasis.io/v1 ` | ` https://testnet.nexus.oasis.io/v1 ` | [ API] [ Nexus-docs ] |
99
- | Oasis Scan ([ Bit Cat] ) | ` https://api.oasisscan.com/v2/mainnet ` | ` https://api.oasisscan.com/v2/testnet ` | [ API] [ OasisScan-docs ] |
33
+ ### Smart Contracts
100
34
101
- [ Nexus-docs ] : https://nexus.oasis.io/v1/spec/v1.html
102
- [ OasisScan-docs ] : https://api.oasisscan.com/v2/swagger/
35
+ Smart Contracts are deployed to [ Sapphire] , an EVM-compatible Layer 1
36
+ blockchain assuring confidential smart contract state. Extra on-chain
37
+ features in your contracts such as the random number generator, cryptography,
38
+ a cross-chain [ privacy layer] ( opl/README.mdx ) and ROFL verification are
39
+ supported.
103
40
104
- ### Rosetta Endpoints
41
+ < DocCard item = { findSidebarItem ( ' /build/sapphire/ ' ) } />
105
42
106
- | Provider | Mainnet URL | Testnet URL |
107
- | ----------| -------------------------------------------| -------------------------------------------|
108
- | [ Oasis] | ` https://rosetta.oasis.io/api/mainnet/v1 ` | ` https://rosetta.oasis.io/api/testnet/v1 ` |
43
+ [ rofl ] : ./rofl/README.mdx
44
+ [ Sapphire ] : ./sapphire/README.mdx
109
45
110
- :::note
46
+ ### Web Browser
111
47
112
- If you are running your own Oasis client node endpoint, a block explorer, an
113
- indexer, or the Rosetta gateway and wish to be added to these docs, open an
114
- issue at [ github.com/oasisprotocol/docs ] .
48
+ Sapphire supports optional encrypted transactions and queries through
49
+ client-side end-to-end encryption. Modern Web3 libraries running in a [ web
50
+ browser ] are supported .
115
51
116
- :::
52
+ [ web browser ] : ./sapphire/develop/browser.md
53
+ <DocCard item = { findSidebarItem (' /build/sapphire/develop/browser' )} />
117
54
118
- [ github.com/oasisprotocol/docs ] : https://github.com/oasisprotocol/docs/issues
55
+ ### Server-Side Apps
119
56
120
- ## See also
57
+ End-to-end encrypted transactions and queries are often required by server-side
58
+ applications running either inside ROFL or outside of the TEE. Check out our
59
+ comprehensive [ API reference guide] for your preferred programming language to
60
+ learn how to integrate with Oasis network.
121
61
122
- < DocCardList items = { [ findSidebarItem ( ' https://api.docs.oasis.io/js/client ' ), findSidebarItem ( ' https://pkg.go.dev/github.com/oasisprotocol/oasis-core/go ' )] } />
62
+ [ API reference guide ] : https://api.docs.oasis.io
0 commit comments