From 856a69929b760a99de8d8771f1033c5100d14f7c Mon Sep 17 00:00:00 2001 From: beruf Date: Wed, 4 Dec 2024 12:49:39 +0100 Subject: [PATCH] docs: move emerald and cipher into other-paratimes - remove truffle section from emerald - add redirects --- docs/README.mdx | 8 +- docs/dapp/README.mdx | 14 +-- docs/dapp/cipher/README.mdx | 117 ------------------ .../cipher/confidential-smart-contract.md | 1 - docs/dapp/cipher/prerequisites.md | 1 - docs/dapp/tools/band.md | 2 +- docs/dapp/tools/other-paratimes/README.mdx | 22 ++++ .../tools/other-paratimes/cipher/README.mdx | 63 ++++++++++ .../cipher/confidential-smart-contract.md | 1 + .../other-paratimes/cipher/hello-world.md | 1 + .../other-paratimes}/cipher/network.mdx | 6 +- .../other-paratimes/cipher/prerequisites.md | 1 + .../other-paratimes}/emerald/README.mdx | 10 +- .../other-paratimes}/emerald/network.mdx | 6 +- .../emerald/writing-dapps-on-emerald.mdx | 34 ++--- docs/general/manage-tokens/README.mdx | 2 +- ...-transfer-eth-erc20-to-emerald-paratime.md | 4 +- docs/node/mainnet/README.md | 2 +- docs/node/web3.mdx | 6 +- external/oasis-sdk | 2 +- external/sapphire-paratime | 2 +- redirects.ts | 12 +- sidebarDapp.ts | 74 ++++++----- src/remark/cross-repo-links.ts | 2 +- 24 files changed, 186 insertions(+), 207 deletions(-) delete mode 100644 docs/dapp/cipher/README.mdx delete mode 120000 docs/dapp/cipher/confidential-smart-contract.md delete mode 120000 docs/dapp/cipher/prerequisites.md create mode 100644 docs/dapp/tools/other-paratimes/README.mdx create mode 100644 docs/dapp/tools/other-paratimes/cipher/README.mdx create mode 120000 docs/dapp/tools/other-paratimes/cipher/confidential-smart-contract.md create mode 120000 docs/dapp/tools/other-paratimes/cipher/hello-world.md rename docs/dapp/{ => tools/other-paratimes}/cipher/network.mdx (92%) create mode 120000 docs/dapp/tools/other-paratimes/cipher/prerequisites.md rename docs/dapp/{ => tools/other-paratimes}/emerald/README.mdx (79%) rename docs/dapp/{ => tools/other-paratimes}/emerald/network.mdx (97%) rename docs/dapp/{ => tools/other-paratimes}/emerald/writing-dapps-on-emerald.mdx (90%) diff --git a/docs/README.mdx b/docs/README.mdx index a72ef5893d..e9d3ecd2f8 100644 --- a/docs/README.mdx +++ b/docs/README.mdx @@ -32,14 +32,14 @@ The part also covers other ParaTimes such as the non-confidential [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 diff --git a/docs/dapp/README.mdx b/docs/dapp/README.mdx index 4b2ba6a52a..c8a81b0962 100644 --- a/docs/dapp/README.mdx +++ b/docs/dapp/README.mdx @@ -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** | | | -| **Non-Confidential** | | | +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, diff --git a/docs/dapp/cipher/README.mdx b/docs/dapp/cipher/README.mdx deleted file mode 100644 index 097cf3ad96..0000000000 --- a/docs/dapp/cipher/README.mdx +++ /dev/null @@ -1,117 +0,0 @@ -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 the 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](../sapphire/README.mdx) paratimes. - -[rust language]: https://www.rust-lang.org/ - -## 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: - - - - - - - -## RPC Endpoints - -:::danger - -The RPC endpoint is a *point of trust*. Beside traffic rate limiting, it can -also perform censorship or even a man-in-the-middle attack. If you have security -considerations, we strongly recommend that you set up your own [ParaTime client -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 - -| Provider | Mainnet RPC URLs | Testnet RPC URLs | -|-----------------------------|---------------------|-----------------------------| -| [Oasis Protocol Foundation] | `grpc.oasis.io:443` | `testnet.grpc.oasis.io:443` | - -[Oasis Protocol Foundation]: https://oasisprotocol.org - -## Block Explorers - -| Name/Provider | Mainnet URL | Testnet URL | EIP-3091 compatible | -|-----------------------------|-------------------------------------------|-------------------------------------------|---------------------| -| Oasis Scan ([Bit Cat]) | [https://www.oasisscan.com/paratimes/000…7cb](https://www.oasisscan.com/paratimes/000000000000000000000000000000000000000000000000e199119c992377cb) | [https://testnet.oasisscan.com/paratimes/000…000](https://testnet.oasisscan.com/paratimes/0000000000000000000000000000000000000000000000000000000000000000) | No | - -[Bit Cat]: https://www.bitcat365.com/ - -:::tip - -Only rudimentary block explorer features exist for Cipher. Consider debugging -the Cipher transactions using the [`oasis paratime show`] command part of the -[Oasis CLI]. - -::: - -[`oasis paratime show`]: ../../general/manage-tokens/cli/paratime.md#show -[Oasis CLI]: ../../general/manage-tokens/cli/README.md - -## Indexers - -| Name (Provider) | Mainnet URL | Testnet URL | Documentation | -|-------------------------------------------|-------------------------------------------------------|--------------------------------------|-------------------| -| Oasis Scan ([Bit Cat]) | `https://api.oasisscan.com/mainnet/v2` | `https://api.oasisscan.com/testnet/v2` | [Mainnet Runtime API][OasisScan-Mainnet-docs], [Testnet Runtime API][OasisScan-Testnet-docs] | - -[OasisScan-Testnet-docs]: https://api.oasisscan.com/testnet/swagger-ui/#/runtime-controller -[OasisScan-Mainnet-docs]: https://api.oasisscan.com/mainnet/swagger-ui/#/runtime-controller - -:::note - -If you are running your own Cipher endpoint, a block explorer, or an indexer -and wish to be added to these docs, open an issue at -[github.com/oasisprotocol/docs]. - -::: - -[github.com/oasisprotocol/docs]: https://github.com/oasisprotocol/docs - -## See also - - - -[Oasis Contract SDK]: - https://github.com/oasisprotocol/oasis-sdk/tree/main/contract-sdk diff --git a/docs/dapp/cipher/confidential-smart-contract.md b/docs/dapp/cipher/confidential-smart-contract.md deleted file mode 120000 index d00d5a8dee..0000000000 --- a/docs/dapp/cipher/confidential-smart-contract.md +++ /dev/null @@ -1 +0,0 @@ -../../../external/oasis-sdk/docs/contract/confidential-smart-contract.md \ No newline at end of file diff --git a/docs/dapp/cipher/prerequisites.md b/docs/dapp/cipher/prerequisites.md deleted file mode 120000 index b500780fc4..0000000000 --- a/docs/dapp/cipher/prerequisites.md +++ /dev/null @@ -1 +0,0 @@ -../../../external/oasis-sdk/docs/contract/prerequisites.md \ No newline at end of file diff --git a/docs/dapp/tools/band.md b/docs/dapp/tools/band.md index 25b973945e..30207b2413 100644 --- a/docs/dapp/tools/band.md +++ b/docs/dapp/tools/band.md @@ -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? diff --git a/docs/dapp/tools/other-paratimes/README.mdx b/docs/dapp/tools/other-paratimes/README.mdx new file mode 100644 index 0000000000..780fbb3c16 --- /dev/null +++ b/docs/dapp/tools/other-paratimes/README.mdx @@ -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** | | | +| **Non-Confidential** | | | + +[Sapphire]: https://github.com/oasisprotocol/docs/blob/main/docs/dapp/sapphire/README.mdx \ No newline at end of file diff --git a/docs/dapp/tools/other-paratimes/cipher/README.mdx b/docs/dapp/tools/other-paratimes/cipher/README.mdx new file mode 100644 index 0000000000..c3261daa0d --- /dev/null +++ b/docs/dapp/tools/other-paratimes/cipher/README.mdx @@ -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: + + + + + + + +## See also + + + +[Oasis Contract SDK]: + https://github.com/oasisprotocol/oasis-sdk/tree/main/contract-sdk diff --git a/docs/dapp/tools/other-paratimes/cipher/confidential-smart-contract.md b/docs/dapp/tools/other-paratimes/cipher/confidential-smart-contract.md new file mode 120000 index 0000000000..07f547bda5 --- /dev/null +++ b/docs/dapp/tools/other-paratimes/cipher/confidential-smart-contract.md @@ -0,0 +1 @@ +../../../../../external/oasis-sdk/docs/contract/confidential-smart-contract.md \ No newline at end of file diff --git a/docs/dapp/tools/other-paratimes/cipher/hello-world.md b/docs/dapp/tools/other-paratimes/cipher/hello-world.md new file mode 120000 index 0000000000..39b1936a9e --- /dev/null +++ b/docs/dapp/tools/other-paratimes/cipher/hello-world.md @@ -0,0 +1 @@ +../../../../../external/oasis-sdk/docs/contract/hello-world.md \ No newline at end of file diff --git a/docs/dapp/cipher/network.mdx b/docs/dapp/tools/other-paratimes/cipher/network.mdx similarity index 92% rename from docs/dapp/cipher/network.mdx rename to docs/dapp/tools/other-paratimes/cipher/network.mdx index 77695707b8..64978343d3 100644 --- a/docs/dapp/cipher/network.mdx +++ b/docs/dapp/tools/other-paratimes/cipher/network.mdx @@ -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 | |-----------------------------|---------------------|-----------------------------| @@ -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 diff --git a/docs/dapp/tools/other-paratimes/cipher/prerequisites.md b/docs/dapp/tools/other-paratimes/cipher/prerequisites.md new file mode 120000 index 0000000000..0e9538c5e3 --- /dev/null +++ b/docs/dapp/tools/other-paratimes/cipher/prerequisites.md @@ -0,0 +1 @@ +../../../../../external/oasis-sdk/docs/contract/prerequisites.md \ No newline at end of file diff --git a/docs/dapp/emerald/README.mdx b/docs/dapp/tools/other-paratimes/emerald/README.mdx similarity index 79% rename from docs/dapp/emerald/README.mdx rename to docs/dapp/tools/other-paratimes/emerald/README.mdx index 60634c4526..ae0d0c73db 100644 --- a/docs/dapp/emerald/README.mdx +++ b/docs/dapp/tools/other-paratimes/emerald/README.mdx @@ -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 diff --git a/docs/dapp/emerald/network.mdx b/docs/dapp/tools/other-paratimes/emerald/network.mdx similarity index 97% rename from docs/dapp/emerald/network.mdx rename to docs/dapp/tools/other-paratimes/emerald/network.mdx index 6c42e5ce32..bd27f683d7 100644 --- a/docs/dapp/emerald/network.mdx +++ b/docs/dapp/tools/other-paratimes/emerald/network.mdx @@ -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 @@ -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): diff --git a/docs/dapp/emerald/writing-dapps-on-emerald.mdx b/docs/dapp/tools/other-paratimes/emerald/writing-dapps-on-emerald.mdx similarity index 90% rename from docs/dapp/emerald/writing-dapps-on-emerald.mdx rename to docs/dapp/tools/other-paratimes/emerald/writing-dapps-on-emerald.mdx index 9729b123cf..20cbbfe28b 100644 --- a/docs/dapp/emerald/writing-dapps-on-emerald.mdx +++ b/docs/dapp/tools/other-paratimes/emerald/writing-dapps-on-emerald.mdx @@ -14,7 +14,7 @@ Those who prefer a simpler web-only interface can also use the Remix IDE. Check general [Remix guide]. Just remember to use the Emerald [networks] when selecting *Inject Web3* environment and connecting to MetaMask. -[Remix guide]: ../tools/remix.md +[Remix guide]: ../..//remix.md [networks]: ./network.mdx#rpc-endpoints ## Oasis Consensus Layer and Emerald ParaTime @@ -43,10 +43,10 @@ account to Emerald. Consult the [How to transfer ROSE into Emerald ParaTime][how-to-deposit-rose] chapter to learn more. -[overview]: ../../general/oasis-network/README.mdx +[overview]: ../../../../general/oasis-network/README.mdx [Ed25519]: https://en.wikipedia.org/wiki/EdDSA#Ed25519 [ECDSA]: https://en.wikipedia.org/wiki/Elliptic_Curve_Digital_Signature_Algorithm -[how-to-deposit-rose]: ../../general/manage-tokens/README.mdx +[how-to-deposit-rose]: ../../../../general/manage-tokens/README.mdx [Testnet faucet]: https://faucet.testnet.oasis.io/ ## Testnet and Mainnet @@ -80,8 +80,8 @@ ParaTime. ::: -[network-parameters]: ../../node/mainnet/README.md -[Testnet]: ../../node/testnet/README.md +[network-parameters]: ../../../..//node/mainnet/README.md +[Testnet]: ../../../../node/testnet/README.md [Emerald Mainnet]: ./network.mdx [Emerald Testnet]: ./network.mdx @@ -90,7 +90,7 @@ ParaTime. For development and testing, you can run a local [instance][localnet] of the entire Emerald stack. -[localnet]: ../tools/localnet.mdx +[localnet]: ../../localnet.mdx ## Create dApp on Emerald with Hardhat @@ -238,9 +238,9 @@ explorer ([Mainnet][mainnet-explorer], [Testnet][testnet-explorer]). This tool indexes all Emerald accounts, blocks, transactions and even offers a neat user interface for browsing ETH-specifics like the ERC20 tokens and the ERC721 NFTs. -![Emerald Block Explorer showing the latest transactions](../images/emerald/block_explorer1.png) +![Emerald Block Explorer showing the latest transactions](../../../images/emerald/block_explorer1.png) -![Emerald Block Explorer showing our account 0x90adE3B7065fa715c7a150313877dF1d33e777D5 used for deploying the smart contract](../images/emerald/block_explorer2.png) +![Emerald Block Explorer showing our account 0x90adE3B7065fa715c7a150313877dF1d33e777D5 used for deploying the smart contract](../../../images/emerald/block_explorer2.png) Finally, by selecting the `emerald_mainnet` network and the corresponding private key, we can deploy the contract on the Mainnet: @@ -256,20 +256,6 @@ Greeter deployed to: 0x6e8e9e0DBCa4EF4a65eBCBe4032e7C2a6fb7C623 ## Troubleshooting -### Truffle Support - -:::info Sunsetting Truffle - -Per Consensys [announcement], Oasis will no longer support Truffle as of -2023-10-05 and encourage immediate [migration] to Hardhat. Please see our -repository for the archived Truffle [tutorial]. - -::: - -[announcement]: https://consensys.io/blog/consensys-announces-the-sunset-of-truffle-and-ganache-and-new-hardhat -[migration]: https://trufflesuite.com/docs/truffle/how-to/migrate-to-hardhat/ -[tutorial]: https://github.com/oasisprotocol/docs/blob/207a7b1a42b4afdac70b925e755f5546723e4831/docs/dapp/emerald/writing-dapps-on-emerald.mdx#L330-L570 - ### Deployment of my contract timed out on Testnet or Mainnet Emerald validators, similar to Ethereum ones, order the execution of @@ -292,7 +278,7 @@ transaction being included in the block. If you are using Testnet or Mainnet, try to debug your transaction by finding it on the Emerald block explorer ([Mainnet][mainnet-explorer], [Testnet][testnet-explorer]): -![Emerald block explorer showing a failed transaction](../images/emerald/oasisscan1.png) +![Emerald block explorer showing a failed transaction](../../../images/emerald/oasisscan1.png) In some cases, the transaction result on Emerald block explorer might be stuck at `Error: (Awaiting internal transactions for reason)`. In this case or in @@ -303,7 +289,7 @@ offers some introspection into ParaTime transactions as well. Once you find your failed Emerald transaction, the `Status` field should contain a more verbose error description, for example: -![Oasis Scan showing the Out of gas error for a transaction on Emerald](../images/emerald/oasisscan2.png) +![Oasis Scan showing the Out of gas error for a transaction on Emerald](../../../images/emerald/oasisscan2.png) ## See also diff --git a/docs/general/manage-tokens/README.mdx b/docs/general/manage-tokens/README.mdx index 438405dbc4..4c7967498a 100644 --- a/docs/general/manage-tokens/README.mdx +++ b/docs/general/manage-tokens/README.mdx @@ -126,7 +126,7 @@ chapter. [MetaMask]: https://metamask.io/download/ [Sapphire]: ../../dapp/sapphire/network.mdx#rpc-endpoints -[Emerald]: ../../dapp/emerald/network.mdx#rpc-endpoints +[Emerald]: ../../dapp/tools/other-paratimes/emerald/network.mdx#rpc-endpoints ### Ledger diff --git a/docs/general/manage-tokens/how-to-transfer-eth-erc20-to-emerald-paratime.md b/docs/general/manage-tokens/how-to-transfer-eth-erc20-to-emerald-paratime.md index f444246f68..8666397aa2 100644 --- a/docs/general/manage-tokens/how-to-transfer-eth-erc20-to-emerald-paratime.md +++ b/docs/general/manage-tokens/how-to-transfer-eth-erc20-to-emerald-paratime.md @@ -6,7 +6,7 @@ the Wormhole token bridge. ## About -[Emerald](/dapp/emerald/) is an Oasis ParaTime providing an Ethereum-compatible blockchain for the Oasis Network. If you want to use any dApp for DEX, NFT and similar built on Emerald, you will have to transfer your assets into the Emerald ParaTime. +[Emerald](/dapp/tools/other-paratimes/emerald/) is an Oasis ParaTime providing an Ethereum-compatible blockchain for the Oasis Network. If you want to use any dApp for DEX, NFT and similar built on Emerald, you will have to transfer your assets into the Emerald ParaTime. To transfer your ROSE tokens into Emerald, read the [Manage tokens](README.mdx). @@ -93,6 +93,6 @@ Now you can start using that wrapped assets across new Oasis dApps like the firs :::info Make sure that your MetaMask is connected to the Emerald Mainnet chain. You -can find the network parameters [here](../../dapp/emerald/network.mdx#rpc-endpoints). +can find the network parameters [here](../../dapp/tools/other-paratimes/emerald/network.mdx#rpc-endpoints). ::: diff --git a/docs/node/mainnet/README.md b/docs/node/mainnet/README.md index 7fd88b25fd..3fd007ef35 100644 --- a/docs/node/mainnet/README.md +++ b/docs/node/mainnet/README.md @@ -111,7 +111,7 @@ Feel free to use other IAS proxies besides the one provided here or :::info -Check the [Emerald ParaTime page](/dapp/emerald/network#rpc-endpoints) on how to access +Check the [Emerald ParaTime page](/dapp/tools/other-paratimes/emerald/network#rpc-endpoints) on how to access the public Web3 endpoint. ::: diff --git a/docs/node/web3.mdx b/docs/node/web3.mdx index 5578a291cf..a1ee2fee3b 100644 --- a/docs/node/web3.mdx +++ b/docs/node/web3.mdx @@ -261,11 +261,11 @@ extended downtime while the Web3 Gateway is reindexing the blocks. ::: -[Emerald]: ../dapp/emerald/README.mdx +[Emerald]: ../dapp/tools/other-paratimes/emerald/README.mdx [Emerald Mainnet launch]: https://medium.com/oasis-protocol-project/oasis-emerald-evm-paratime-is-live-on-mainnet-13afe953a4c9 -[emerald-mainnet]: ../dapp/emerald/network.mdx -[emerald-testnet]: ../dapp/emerald/network.mdx +[emerald-mainnet]: ../dapp/tools/other-paratimes/emerald/network.mdx +[emerald-testnet]: ../dapp/tools/other-paratimes/emerald/network.mdx [github-releases]: https://github.com/oasisprotocol/oasis-web3-gateway/releases [Mainnet]: mainnet/README.md [mainnet-emerald]: mainnet/README.md#emerald diff --git a/external/oasis-sdk b/external/oasis-sdk index c274d2105c..3a8f25df61 160000 --- a/external/oasis-sdk +++ b/external/oasis-sdk @@ -1 +1 @@ -Subproject commit c274d2105c80be28559132963dbc38a035dff53b +Subproject commit 3a8f25df618545399e331cbf641096a6bb9eed64 diff --git a/external/sapphire-paratime b/external/sapphire-paratime index a4069ee150..50e60a1df8 160000 --- a/external/sapphire-paratime +++ b/external/sapphire-paratime @@ -1 +1 @@ -Subproject commit a4069ee1500873ee4becbfbbce23feb6f3c97702 +Subproject commit 50e60a1df8c98c1c47cfcbc71b8036947b7b52f4 diff --git a/redirects.ts b/redirects.ts index 29a6cf214c..cb92d565fb 100644 --- a/redirects.ts +++ b/redirects.ts @@ -145,7 +145,7 @@ export const redirectsOptions: Options = { ], }, { - to: '/dapp/cipher/', + to: '/dapp/tools/other-paratimes/cipher/', from: '/oasis-sdk/contract/getting-started', // #200 Restructure docs }, { @@ -284,7 +284,15 @@ export const redirectsOptions: Options = { { to: '/dapp/tools/band', from: '/dapp/emerald/integrating-band-oracle-smart-contract', // #907 Move Band oracle to Tools section - } + }, + { + to: '/dapp/tools/other-paratimes/emerald/', + from: '/dapp/emerald/', // #1041 Move Emerald and Cipher to /tools/other-paratimes/ + }, + { + to: '/dapp/tools/other-paratimes/cipher/', + from: '/dapp/cipher/', // #1041 Move Emerald and Cipher to /tools/other-paratimes/ + }, ], createRedirects(existingPath) { // #119 Add /oasis-core/adr/* -> /adrs/* redirection diff --git a/sidebarDapp.ts b/sidebarDapp.ts index 871b91165d..91e1d942aa 100644 --- a/sidebarDapp.ts +++ b/sidebarDapp.ts @@ -83,37 +83,6 @@ export const sidebarDapp: SidebarsConfig = { }, ], }, - { - type: 'category', - label: 'Cipher', - link: { - type: 'doc', - id: 'dapp/cipher/README', - }, - items: [ - 'dapp/cipher/prerequisites', - 'dapp/cipher/network', - 'dapp/cipher/hello-world', - 'dapp/cipher/confidential-smart-contract', - { - type: 'link', - label: 'Rust API', - href: 'https://api.docs.oasis.io/rust/oasis_contract_sdk', - }, - ], - }, - { - type: 'category', - label: 'Emerald', - link: { - type: 'doc', - id: 'dapp/emerald/README', - }, - items: [ - 'dapp/emerald/network', - 'dapp/emerald/writing-dapps-on-emerald', - ], - }, { type: 'category', label: 'Tools & Services', @@ -125,7 +94,48 @@ export const sidebarDapp: SidebarsConfig = { 'dapp/tools/abi-playground', 'dapp/tools/band', 'dapp/tools/localnet', - 'dapp/tools/remix' + 'dapp/tools/remix', + { + type: 'category', + label: 'Other Paratimes', + link: { + type: 'doc', + id: 'dapp/tools/other-paratimes/README', + }, + items: [ + { + type: 'category', + label: 'Emerald', + link: { + type: 'doc', + id: 'dapp/tools/other-paratimes/emerald/README', + }, + items: [ + 'dapp/tools/other-paratimes/emerald/network', + 'dapp/tools/other-paratimes/emerald/writing-dapps-on-emerald', + ], + }, + { + type: 'category', + label: 'Cipher', + link: { + type: 'doc', + id: 'dapp/tools/other-paratimes/cipher/README', + }, + items: [ + 'dapp/tools/other-paratimes/cipher/prerequisites', + 'dapp/tools/other-paratimes/cipher/network', + 'dapp/tools/other-paratimes/cipher/hello-world', + 'dapp/tools/other-paratimes/cipher/confidential-smart-contract', + { + type: 'link', + label: 'Rust API', + href: 'https://api.docs.oasis.io/rust/oasis_contract_sdk', + }, + ], + } + ], + }, ], }, ], diff --git a/src/remark/cross-repo-links.ts b/src/remark/cross-repo-links.ts index 0c05dba208..0c3507a688 100644 --- a/src/remark/cross-repo-links.ts +++ b/src/remark/cross-repo-links.ts @@ -29,7 +29,7 @@ export default function plugin(): Transformer { function visitor(untypedNode: mdast.Node) { const node = untypedNode as mdast.Definition | mdast.Link if (oasisSdkContractRegex.test(node.url)) { - node.url = node.url.replace(oasisSdkContractRegex, '/dapp/cipher/$1$2'); + node.url = node.url.replace(oasisSdkContractRegex, '/dapp/tools/other-paratimes/cipher/$1$2'); } else if (oasisSdkRuntimeRegex.test(node.url)) { node.url = node.url.replace(oasisSdkRuntimeRegex, '/paratime/$1$2'); } else if (oasisSdkRoflRegex.test(node.url)) {