Skip to content

Commit

Permalink
fix: relative links and cross-repo links
Browse files Browse the repository at this point in the history
- plus removed duplicated network info of cipher
  • Loading branch information
rube-de committed Dec 9, 2024
1 parent f76ff69 commit 7a40d30
Show file tree
Hide file tree
Showing 5 changed files with 21 additions and 69 deletions.
2 changes: 1 addition & 1 deletion docs/dapp/tools/other-paratimes/README.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -19,4 +19,4 @@ Learn more by exploring the ParaTimes below!
| **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]: /dapp/sapphire/README.mdx
[Sapphire]: https://github.com/oasisprotocol/docs/blob/main/docs/dapp/sapphire/README.mdx
68 changes: 7 additions & 61 deletions docs/dapp/tools/other-paratimes/cipher/README.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,16 @@ allows for:

If you're looking for EVM-compatible ParaTimes, check out the
[Emerald](../emerald/README.mdx) and the confidential
[Sapphire](/dapp/sapphire/README.mdx) paratimes.
[Sapphire](https://github.com/oasisprotocol/docs/blob/main/docs/dapp/sapphire/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
Expand All @@ -43,66 +49,6 @@ Oasis Contract SDK chapters:
findSidebarItem('/dapp/tools/other-paratimes/cipher/confidential-smart-contract')
} />

## 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

<DocCardList items={[
Expand Down
6 changes: 3 additions & 3 deletions docs/dapp/tools/other-paratimes/cipher/network.mdx
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
8 changes: 7 additions & 1 deletion docs/dapp/tools/other-paratimes/emerald/README.mdx
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](/dapp/sapphire/README.mdx).
[Sapphire ParaTime](https://github.com/oasisprotocol/docs/blob/main/docs/dapp/sapphire/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 Down
6 changes: 3 additions & 3 deletions docs/dapp/tools/other-paratimes/emerald/network.mdx
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]: /dapp/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

0 comments on commit 7a40d30

Please sign in to comment.