Skip to content

Commit

Permalink
docs: move emerald and cipher into other-paratimes
Browse files Browse the repository at this point in the history
- remove truffle section from emerald
  • Loading branch information
rube-de committed Dec 4, 2024
1 parent a06e729 commit b8d7851
Show file tree
Hide file tree
Showing 13 changed files with 71 additions and 75 deletions.
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/hello-world.md

This file was deleted.

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

This file was deleted.

Empty file.
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ allows for:

If you're looking for EVM-compatible ParaTimes, check out the
[Emerald](../emerald/README.mdx) and the confidential
[Sapphire](../sapphire/README.mdx) paratimes.
[Sapphire](/dapp/sapphire/README.mdx) paratimes.

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

Expand All @@ -32,15 +32,15 @@ confidential smart contract in Rust and deploy it on Cipher, read the related
Oasis Contract SDK chapters:

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

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

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

## RPC Endpoints
Expand All @@ -57,7 +57,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 @@ -81,8 +81,8 @@ the Cipher transactions using the [`oasis paratime show`] command part of 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 All @@ -109,7 +109,7 @@ and wish to be added to these docs, open an issue at
findSidebarItem('/general/manage-tokens/'),
findSidebarItem('/node/run-your-node/paratime-node'),
findSidebarItem('/node/run-your-node/paratime-client-node'),
findSidebarItem('/dapp/emerald/'),
findSidebarItem('/dapp/tools/other-paratimes/emerald/'),
findSidebarItem('/dapp/sapphire/'),
]} />

Expand Down
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,7 +16,7 @@ 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](/dapp/sapphire/README.mdx).

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

Expand All @@ -28,5 +28,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]: /dapp/tools/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
Original file line number Diff line number Diff line change
Expand Up @@ -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]: /dapp/tools/remix.md
[networks]: ./network.mdx#rpc-endpoints

## Oasis Consensus Layer and Emerald ParaTime
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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

Expand All @@ -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]: /dapp/tools/localnet.mdx

## Create dApp on Emerald with Hardhat

Expand Down Expand Up @@ -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:
Expand All @@ -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
Expand All @@ -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
Expand All @@ -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

Expand Down
74 changes: 42 additions & 32 deletions sidebarDapp.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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',
Expand All @@ -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',
},
],
}
],
},
],
},
],
Expand Down

0 comments on commit b8d7851

Please sign in to comment.