Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: move emerald and cipher into other-paratimes #1041

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions docs/README.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -32,14 +32,14 @@ The part also covers other ParaTimes such as the non-confidential
<DocCardList items={[
findSidebarItem('/dapp/sapphire/'),
findSidebarItem('/dapp/opl/'),
findSidebarItem('/dapp/emerald/'),
findSidebarItem('/dapp/cipher/'),
findSidebarItem('/dapp/tools/other-paratimes/emerald/'),
findSidebarItem('/dapp/tools/other-paratimes/cipher/'),
]} />

[Oasis Sapphire]: dapp/sapphire/README.mdx
[Oasis Privacy Layer]: dapp/opl/README.mdx
[Oasis Emerald]: dapp/emerald/README.mdx
[Oasis Cipher]: dapp/emerald/README.mdx
[Oasis Emerald]: dapp/tools/other-paratimes/emerald/README.mdx
[Oasis Cipher]: dapp/tools/other-paratimes/cipher/README.mdx

## Build ROFL

Expand Down
14 changes: 7 additions & 7 deletions docs/dapp/README.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,17 +12,17 @@ import {findSidebarItem} from '@site/src/sidebarUtils';

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

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

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

[Oasis architecture]: ../general/oasis-network/README.mdx
[Sapphire]: /dapp/sapphire/README.mdx
[Other ParaTimes]: /dapp/tools/other-paratimes/README.mdx

## Oasis Privacy Layer

In addition to building fully native dApps running on one of the Oasis
ParaTimes, you can also add privacy to your existing dApps running on other,
Expand Down
117 changes: 0 additions & 117 deletions docs/dapp/cipher/README.mdx

This file was deleted.

1 change: 0 additions & 1 deletion docs/dapp/cipher/confidential-smart-contract.md

This file was deleted.

1 change: 0 additions & 1 deletion docs/dapp/cipher/prerequisites.md

This file was deleted.

2 changes: 1 addition & 1 deletion docs/dapp/tools/band.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ for full list of deployed contract addresses.
:::

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

### What is the Band Protocol?
Expand Down
22 changes: 22 additions & 0 deletions docs/dapp/tools/other-paratimes/README.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
description: Other Paratimes
---
import DocCard from '@theme/DocCard';
import DocCardList from '@theme/DocCardList';
import {findSidebarItem} from '@site/src/sidebarUtils';

# Other ParaTimes

In addition to our primary ParaTime, [Sapphire], several additional ParaTimes
are running on top of the consensus layer.
DApp developers can choose a Paratime to build on according to their
specific requirements, such as confidentiality and EVM compatibility.

Learn more by exploring the ParaTimes below!

| | EVM-compatible | Oasis Wasm |
|---------------------:|-------------------------------------------------------|-----------------------------------------------------|
| **Confidential** | <DocCard item={findSidebarItem('/dapp/sapphire/')} /> | <DocCard item={findSidebarItem('/dapp/tools/other-paratimes/cipher/')} /> |
| **Non-Confidential** | <DocCard item={findSidebarItem('/dapp/tools/other-paratimes/emerald/')} /> | |

[Sapphire]: https://github.com/oasisprotocol/docs/blob/main/docs/dapp/sapphire/README.mdx
63 changes: 63 additions & 0 deletions docs/dapp/tools/other-paratimes/cipher/README.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
import DocCard from '@theme/DocCard';
import DocCardList from '@theme/DocCardList';
import {findSidebarItem} from '@site/src/sidebarUtils';

# Cipher ParaTime

Cipher is a confidential ParaTime for executing Wasm smart contracts.

As an officially supported ParaTime by the Oasis Protocol Foundation, Cipher
allows for:

* Flexibility: developer can define which data to store in a public
and which data in the (more expensive) confidential storage
* Security: the [Rust language] primarily used for writing Wasm smart contracts
is known for its strict memory management and was developed specifically to
avoid memory leaks
* Scalability: increased throughput of transactions
* Low-cost: 99%+ lower fees than Ethereum
* 6 second finality (1 block)
* Cross-chain bridge to enable cross-chain interoperability (upcoming)

If you're looking for EVM-compatible ParaTimes, check out the
[Emerald](../emerald/README.mdx) and the confidential
[Sapphire](https://github.com/oasisprotocol/sapphire-paratime/blob/main/docs/README.mdx) paratimes.

[Rust language]: https://www.rust-lang.org/

## Network Information

See crucial network information [here][network].

[network]: ./network.mdx

## Smart Contract Development

Cipher implements the [Oasis Contract SDK] API. To learn how to write a
confidential smart contract in Rust and deploy it on Cipher, read the related
Oasis Contract SDK chapters:

<DocCard item={
findSidebarItem('/dapp/tools/other-paratimes/cipher/prerequisites')
} />

<DocCard item={
findSidebarItem('/dapp/tools/other-paratimes/cipher/hello-world')
} />

<DocCard item={
findSidebarItem('/dapp/tools/other-paratimes/cipher/confidential-smart-contract')
} />

## See also

<DocCardList items={[
findSidebarItem('/general/manage-tokens/'),
findSidebarItem('/node/run-your-node/paratime-node'),
findSidebarItem('/node/run-your-node/paratime-client-node'),
findSidebarItem('/dapp/tools/other-paratimes/emerald/'),
findSidebarItem('/dapp/sapphire/'),
]} />

[Oasis Contract SDK]:
https://github.com/oasisprotocol/oasis-sdk/tree/main/contract-sdk
1 change: 1 addition & 0 deletions docs/dapp/tools/other-paratimes/cipher/hello-world.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ node][paratime-client-node].
Cipher endpoints share the gRPC protocol with the Oasis Core. You can connect to
one of the public endpoints below (in alphabetic order):

[paratime-client-node]: ../../node/run-your-node/paratime-client-node.mdx
[paratime-client-node]: ../../../../node/run-your-node/paratime-client-node.mdx

| Provider | Mainnet RPC URLs | Testnet RPC URLs |
|-----------------------------|---------------------|-----------------------------|
Expand All @@ -42,8 +42,8 @@ Cipher transactions with the [`oasis paratime show`] command using the

:::

[`oasis paratime show`]: ../../general/manage-tokens/cli/paratime.md#show
[Oasis CLI]: ../../general/manage-tokens/cli/README.md
[`oasis paratime show`]: ../../../../general/manage-tokens/cli/paratime.md#show
[Oasis CLI]: ../../../../general/manage-tokens/cli/README.md

## Indexers

Expand Down
1 change: 1 addition & 0 deletions docs/dapp/tools/other-paratimes/cipher/prerequisites.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,16 @@ DeFi, NFT, Metaverse and crypto gaming
* Cross-chain bridge to enable cross-chain interoperability (upcoming)

If you're looking for EVM, but with confidentiality, check out the
[Sapphire ParaTime](../sapphire/README.mdx).
[Sapphire ParaTime](https://github.com/oasisprotocol/sapphire-paratime/blob/main/docs/README.mdx).

[Ethereum Virtual Machine (EVM)]: https://ethereum.org/en/developers/docs/evm/

## Network Information

See crucial network information [here][network].

[network]: ./network.mdx

## See also

<DocCardList items={[
Expand All @@ -28,5 +34,5 @@ If you're looking for EVM, but with confidentiality, check out the
findSidebarItem('/node/run-your-node/paratime-client-node'),
findSidebarItem('/node/web3'),
findSidebarItem('/dapp/sapphire/'),
findSidebarItem('/dapp/cipher/'),
findSidebarItem('/dapp/tools/other-paratimes/cipher/'),
]} />
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ import {AddEmeraldToMetaMask as E, AddEmeraldTestnetToMetaMask as ET} from '@sit
| Tools | | [Testing token Faucet][faucet] | [Local development Docker image][localnet]

[faucet]: https://faucet.testnet.oasis.io/
[localnet]: ../tools/localnet.mdx
[localnet]: ../../localnet.mdx

## RPC Endpoints

Expand All @@ -30,8 +30,8 @@ node][paratime-client-node] and the [Web3-compatible gateway].
:::


[Web3-compatible gateway]: ../../node/web3.mdx
[paratime-client-node]: ../../node/run-your-node/paratime-client-node.mdx
[Web3-compatible gateway]: ../../../../node/web3.mdx
[paratime-client-node]: ../../../../node/run-your-node/paratime-client-node.mdx

You can connect to one of the public Web3 gateways below (in alphabetic order):

Expand Down
Loading
Loading