Skip to content

Commit

Permalink
fix(docs): use constants file for urls everywhere in docs (#4443)
Browse files Browse the repository at this point in the history
* Update all relevant files to use the constant file URLs
  • Loading branch information
vivekjain23 authored Dec 23, 2024
1 parent 1e33900 commit 385e36a
Show file tree
Hide file tree
Showing 4 changed files with 14 additions and 10 deletions.
8 changes: 4 additions & 4 deletions docs/content/_snippets/iota-evm/oracles_contract_data.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,10 @@ import { Networks } from '@site/src/components/constant';

| Contract Type | Contract Address |
|:----------------------:|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------:|
| Pyth contract | [https://explorer.evm.shimmer.network/address/0x290f23E4a034Db5237edCb5aA2D94Acb4DD19fD2](https://explorer.evm.shimmer.network/address/0x290f23E4a034Db5237edCb5aA2D94Acb4DD19fD2) |
| Supra Pull Contract | [https://explorer.evm.shimmer.network/address/0xe41444462709484272F54371F3f53bBF900Ec49E](https://explorer.evm.shimmer.network/address/0xe41444462709484272F54371F3f53bBF900Ec49E) |
| Supra Storage Contract | [https://explorer.evm.shimmer.network/address/0x3E5E89d14576cE9f20a8347aA682517fe65B4ACB](https://explorer.evm.shimmer.network/address/0x3E5E89d14576cE9f20a8347aA682517fe65B4ACB) |
| Supra Push Contract | [https://explorer.evm.shimmer.network/address/0x3df842b27c997cEc63160E79CB4398c82645A1c3](https://explorer.evm.shimmer.network/address/0x3df842b27c997cEc63160E79CB4398c82645A1c3) |
| Pyth contract | [<>{Networks.shimmer.evm.blockExplorerUrls}</>/address/0x290f23E4a034Db5237edCb5aA2D94Acb4DD19fD2](https://explorer.evm.shimmer.network/address/0x290f23E4a034Db5237edCb5aA2D94Acb4DD19fD2) |
| Supra Pull Contract | [<>{Networks.shimmer.evm.blockExplorerUrls}</>/address/0xe41444462709484272F54371F3f53bBF900Ec49E](https://explorer.evm.shimmer.network/address/0xe41444462709484272F54371F3f53bBF900Ec49E) |
| Supra Storage Contract | [<>{Networks.shimmer.evm.blockExplorerUrls}</>/address/0x3E5E89d14576cE9f20a8347aA682517fe65B4ACB](https://explorer.evm.shimmer.network/address/0x3E5E89d14576cE9f20a8347aA682517fe65B4ACB) |
| Supra Push Contract | [<>{Networks.shimmer.evm.blockExplorerUrls}</>/address/0x3df842b27c997cEc63160E79CB4398c82645A1c3](https://explorer.evm.shimmer.network/address/0x3df842b27c997cEc63160E79CB4398c82645A1c3) |

</TabItem>
</Tabs>
Expand Down
8 changes: 5 additions & 3 deletions docs/content/developer/advanced/custom-indexer.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ description: You can build custom indexers using the IOTA micro-data ingestion f

import Quiz from '@site/src/components/Quiz';
import questions from '/json/developer/advanced-topics/custom-indexer.json';
import {Networks} from '@site/src/components/constant'
import CodeBlock from '@theme/CodeBlock';

You can build custom indexers using the IOTA micro-data ingestion framework. To create an indexer, you subscribe to a checkpoint stream with full checkpoint content. This stream can be one of the publicly available streams from IOTA, one that you set up in your local environment, or a combination of the two.

Expand All @@ -31,10 +33,10 @@ Data ingestion for your indexer supports several checkpoint stream sources.

The most straightforward stream source is to subscribe to a remote store of checkpoint contents. IOTA provides the following buckets:

- Testnet: `https://indexer.testnet.iota.cafe`
- Devnet: `https://indexer.devnet.iota.cafe`
- Testnet: <CodeBlock>{Networks.iota_move_testnet.indexerRpc}</CodeBlock>
- Devnet: <CodeBlock>{Networks.iota_move_devnet.indexerRpc}</CodeBlock>

The checkpoint files are stored in the following format: `https://indexer.testnet.iota.cafe/<checkpoint_id>.chk`. You can download the checkpoint file by sending an HTTP GET request to the relevant URL. Try it yourself for checkpoint 1 at [https://indexer.testnet.iota.cafe/1.chk](https://indexer.testnet.iota.cafe/1.chk).
The checkpoint files are stored in the following format: <code>{Networks.iota_move_testnet.indexerRpc+`/<checkpoint_id>.chk`}</code>. You can download the checkpoint file by sending an HTTP GET request to the relevant URL. Try it yourself for checkpoint 1 at [{Networks.iota_move_testnet.indexerRpc}/1.chk](https://indexer.testnet.iota.cafe/1.chk).

```mermaid
flowchart LR
Expand Down
3 changes: 2 additions & 1 deletion docs/content/developer/getting-started/get-coins.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ tags: [how-to, cli, typescript, sdk, faucet]
---
import Quiz from '@site/src/components/Quiz';
import questions from '/json/developer/getting-started/get-coins.json';
import {Networks} from '@site/src/components/constant'

# Get Test Tokens

Expand Down Expand Up @@ -36,7 +37,7 @@ curl --location --request POST 'https://faucet.testnet.iota.cafe/gas' \

:::tip Test tokens on a local network

If you're working with a local network, replace `'https://faucet.devnet.iota.cafe/gas'` with the appropriate value based on which package runs your network:
If you're working with a local network, replace <code>{Networks.iota_move_devnet.faucetUrl}</code> with the appropriate value based on which package runs your network:

- `iota-faucet`: `http://127.0.0.1:5003/gas`
- `iota start`: `http://127.0.0.1:9123/gas`
Expand Down
5 changes: 3 additions & 2 deletions docs/content/operator/iota-full-node/source.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ import Quiz from '@site/src/components/Quiz';
import questions from '/json/node-operators/iota-full-node/node-setup.json';
import WarningAdvanced from './../../_snippets/warning-advanced-instructions-node-setup.mdx'
import NodeHardwareRequirements from './../../_snippets/node-hardware-requirements.mdx'
import {Networks} from '@site/src/components/constant'

<WarningAdvanced/>

Expand Down Expand Up @@ -150,7 +151,7 @@ At this point, your IOTA Full node is ready to connect to the IOTA network.

If your setup is successful, your IOTA Full node is now connected to the appropriate network.

Your Full node serves the read endpoints of the IOTA JSON-RPC API at: `http://127.0.0.1:9000`.
Your Full node serves the read endpoints of the IOTA JSON-RPC API at: <code>{Networks.iota_localnet.jsonRpcUrl}</code>.

## Troubleshooting

Expand Down Expand Up @@ -216,7 +217,7 @@ Use the following steps to update your Full node:
./target/release/iota-node --config-path fullnode.yaml
```

Your Full node restarts on: http://127.0.0.1:9000.
Your Full node restarts on: <code>{Networks.iota_localnet.jsonRpcUrl}</code>.

:::info

Expand Down

0 comments on commit 385e36a

Please sign in to comment.