Skip to content

Commit 792ebcc

Browse files
authored
Merge pull request #1041 from oasisprotocol/rube/979-remove-truffle-section-from-emerald
docs: move emerald and cipher into other-paratimes
2 parents 5ac3365 + ac9a27e commit 792ebcc

26 files changed

+187
-208
lines changed

docs/README.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -32,14 +32,14 @@ The part also covers other ParaTimes such as the non-confidential
3232
<DocCardList items={[
3333
findSidebarItem('/dapp/sapphire/'),
3434
findSidebarItem('/dapp/opl/'),
35-
findSidebarItem('/dapp/emerald/'),
36-
findSidebarItem('/dapp/cipher/'),
35+
findSidebarItem('/dapp/tools/other-paratimes/emerald/'),
36+
findSidebarItem('/dapp/tools/other-paratimes/cipher/'),
3737
]} />
3838

3939
[Oasis Sapphire]: dapp/sapphire/README.mdx
4040
[Oasis Privacy Layer]: dapp/opl/README.mdx
41-
[Oasis Emerald]: dapp/emerald/README.mdx
42-
[Oasis Cipher]: dapp/emerald/README.mdx
41+
[Oasis Emerald]: dapp/tools/other-paratimes/emerald/README.mdx
42+
[Oasis Cipher]: dapp/tools/other-paratimes/cipher/README.mdx
4343

4444
## Build ROFL
4545

docs/dapp/README.mdx

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -12,17 +12,17 @@ import {findSidebarItem} from '@site/src/sidebarUtils';
1212

1313
The [Oasis architecture] is designed to have a simple, robust consensus layer
1414
on top which connects handful of ParaTimes executing smart contracts.
15-
DApp developers may choose among those ParaTimes depending on whether they
16-
require confidentiality and/or EVM-compatibility.
1715

18-
Learn more by exploring the ParaTimes below!
16+
[Sapphire] is the primary ParaTime. It is EVM-compatible and allows you to
17+
write both confidential and non-confidential smart contracts.
1918

20-
| | EVM-compatible | Oasis Wasm |
21-
|---------------------:|-------------------------------------------------------|-----------------------------------------------------|
22-
| **Confidential** | <DocCard item={findSidebarItem('/dapp/sapphire/')} /> | <DocCard item={findSidebarItem('/dapp/cipher/')} /> |
23-
| **Non-Confidential** | <DocCard item={findSidebarItem('/dapp/emerald/')} /> | |
19+
For an overview of the other ParaTimes, refer to the [Other ParaTimes] chapter.
2420

2521
[Oasis architecture]: ../general/oasis-network/README.mdx
22+
[Sapphire]: https://github.com/oasisprotocol/docs/blob/main/docs/dapp/sapphire/README.mdx
23+
[Other ParaTimes]: ./tools/other-paratimes/README.mdx
24+
25+
## Oasis Privacy Layer
2626

2727
In addition to building fully native dApps running on one of the Oasis
2828
ParaTimes, you can also add privacy to your existing dApps running on other,

docs/dapp/cipher/README.mdx

Lines changed: 0 additions & 116 deletions
This file was deleted.

docs/dapp/cipher/confidential-smart-contract.md

Lines changed: 0 additions & 1 deletion
This file was deleted.

docs/dapp/cipher/hello-world.md

Lines changed: 0 additions & 1 deletion
This file was deleted.

docs/dapp/cipher/prerequisites.md

Lines changed: 0 additions & 1 deletion
This file was deleted.

docs/dapp/tools/band.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,8 @@ for full list of deployed contract addresses.
1616

1717
:::
1818

19-
[paratime]: /general/oasis-network/faq#how-is-a-paratime-different-from-a-parachain
20-
[emerald]: /dapp/emerald
19+
[paratime]: ../../general/oasis-network/faq#how-is-a-paratime-different-from-a-parachain
20+
[emerald]: ./other-paratimes/emerald/README.mdx
2121
[band-supported-blockchains]: https://docs.bandchain.org/develop/supported-blockchains
2222

2323
### What is the Band Protocol?
Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
description: Other Paratimes
3+
---
4+
import DocCard from '@theme/DocCard';
5+
import DocCardList from '@theme/DocCardList';
6+
import {findSidebarItem} from '@site/src/sidebarUtils';
7+
8+
# Other ParaTimes
9+
10+
In addition to our primary ParaTime, [Sapphire], several additional ParaTimes
11+
are running on top of the consensus layer.
12+
DApp developers can choose a Paratime to build on according to their
13+
specific requirements, such as confidentiality and EVM compatibility.
14+
15+
Learn more by exploring the ParaTimes below!
16+
17+
| | EVM-compatible | Oasis Wasm |
18+
|---------------------:|-------------------------------------------------------|-----------------------------------------------------|
19+
| **Confidential** | <DocCard item={findSidebarItem('/dapp/sapphire/')} /> | <DocCard item={findSidebarItem('/dapp/tools/other-paratimes/cipher/')} /> |
20+
| **Non-Confidential** | <DocCard item={findSidebarItem('/dapp/tools/other-paratimes/emerald/')} /> | |
21+
22+
[Sapphire]: https://github.com/oasisprotocol/docs/blob/main/docs/dapp/sapphire/README.mdx
Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
import DocCard from '@theme/DocCard';
2+
import DocCardList from '@theme/DocCardList';
3+
import {findSidebarItem} from '@site/src/sidebarUtils';
4+
5+
# Cipher ParaTime
6+
7+
Cipher is a confidential ParaTime for executing Wasm smart contracts.
8+
9+
As an officially supported ParaTime by the Oasis Protocol Foundation, Cipher
10+
allows for:
11+
12+
* Flexibility: developer can define which data to store in a public
13+
and which data in the (more expensive) confidential storage
14+
* Security: the [Rust language] primarily used for writing Wasm smart contracts
15+
is known for its strict memory management and was developed specifically to
16+
avoid memory leaks
17+
* Scalability: increased throughput of transactions
18+
* Low-cost: 99%+ lower fees than Ethereum
19+
* 6 second finality (1 block)
20+
* Cross-chain bridge to enable cross-chain interoperability (upcoming)
21+
22+
If you're looking for EVM-compatible ParaTimes, check out the
23+
[Emerald](../emerald/README.mdx) and the confidential
24+
[Sapphire](https://github.com/oasisprotocol/sapphire-paratime/blob/main/docs/README.mdx) paratimes.
25+
26+
[Rust language]: https://www.rust-lang.org/
27+
28+
## Network Information
29+
30+
See crucial network information [here][network].
31+
32+
[network]: ./network.mdx
33+
34+
## Smart Contract Development
35+
36+
Cipher implements the [Oasis Contract SDK] API. To learn how to write a
37+
confidential smart contract in Rust and deploy it on Cipher, read the related
38+
Oasis Contract SDK chapters:
39+
40+
<DocCard item={
41+
findSidebarItem('/dapp/tools/other-paratimes/cipher/prerequisites')
42+
} />
43+
44+
<DocCard item={
45+
findSidebarItem('/dapp/tools/other-paratimes/cipher/hello-world')
46+
} />
47+
48+
<DocCard item={
49+
findSidebarItem('/dapp/tools/other-paratimes/cipher/confidential-smart-contract')
50+
} />
51+
52+
## See also
53+
54+
<DocCardList items={[
55+
findSidebarItem('/general/manage-tokens/'),
56+
findSidebarItem('/node/run-your-node/paratime-node'),
57+
findSidebarItem('/node/run-your-node/paratime-client-node'),
58+
findSidebarItem('/dapp/tools/other-paratimes/emerald/'),
59+
findSidebarItem('/dapp/sapphire/'),
60+
]} />
61+
62+
[Oasis Contract SDK]:
63+
https://github.com/oasisprotocol/oasis-sdk/tree/main/contract-sdk
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../../../../../external/oasis-sdk/docs/contract/confidential-smart-contract.md

0 commit comments

Comments
 (0)