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.

Sign up for GitHub

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

Fix admonitions #4455

Merged
merged 3 commits into from
Dec 13, 2024
Merged

Fix admonitions #4455

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2960830
fix(docs): Update rate limit admonition
Dr-Electron Dec 11, 2024
610b50d
Update admonition
Dr-Electron Dec 11, 2024
0c326d7
Update docs/content/references/ts-sdk/typescript/index.mdx
Dr-Electron Dec 13, 2024
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
7 changes: 7 additions & 0 deletions docs/content/_snippets/info-high-traffic.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
:::info

It is suggested to use dedicated nodes/shared services rather than public endpoints for production apps with high traffic volume.

You can either run your own Full nodes, or outsource this to a professional infrastructure provider (preferred for apps that have high traffic).
Dr-Electron marked this conversation as resolved.
Show resolved Hide resolved

:::
9 changes: 0 additions & 9 deletions docs/content/_snippets/warn-ml-rpcs.mdx
View file
Open in desktop

This file was deleted.

2 changes: 1 addition & 1 deletion docs/content/references/iota-api.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ title: IOTA RPC
:::info


The IOTA RPC is upgrading from JSON-RPC to GraphQL. See [GraphQL for IOTA RPC](../developer/graphql-rpc.mdx) for more information.
Checkout our experimental [GraphQL for IOTA RPC](../developer/graphql-rpc.mdx) as an alternative option.


:::
Expand Down
4 changes: 2 additions & 2 deletions docs/content/references/iota-api/rpc-best-practices.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@
title: RPC Best Practices
---

import WarnMlRpcs from "../../_snippets/warn-ml-rpcs.mdx";
import HighTrafficRpcs from "../../_snippets/info-high-traffic.mdx";

This topic provides some best practices for configuring your RPC settings to ensure a reliable infrastructure for your projects and services built on IOTA.

<WarnMlRpcs />
<HighTrafficRpcs />

## RPC provisioning guidance

Expand Down
17 changes: 4 additions & 13 deletions docs/content/references/ts-sdk/typescript/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
import NetworkInfo from "@site/src/components/NetworkInfo/index.tsx";
import { Networks } from '@site/src/components/constant.tsx';
import HighTrafficRpcs from "@site/../content/_snippets/info-high-traffic.mdx";

# IOTA TypeScript SDK Quick Start

Expand All @@ -16,6 +17,9 @@ npm i @iota/iota-sdk

The following table lists the locations for IOTA networks.

{ /* TODO: Shhould be moved to mainnet once it is live */ }
Dr-Electron marked this conversation as resolved.
Show resolved Hide resolved
<HighTrafficRpcs />

## IOTA Testnet

<NetworkInfo.Move {...Networks['iota_move_testnet']}/>
Expand All @@ -30,19 +34,6 @@ To create a local IOTA network, you can refer to [Local Development](/developer/

<NetworkInfo.Move {...Networks['iota_localnet']}/>

:::warning

Use dedicated nodes/shared services rather than public endpoints for production apps. The public
endpoints maintained by the IOTA Foundation (`api.<NETWORK>.iota.cafe:443`) are rate-limited, and support
only 100 requests per 30 seconds or so. Do not use public endpoints in production applications with
high traffic volume.

You can either run your own Full nodes, or outsource this to a professional infrastructure provider
(preferred for apps that have high traffic). You can find a list of reliable RPC endpoint providers
for IOTA on the [IOTA Dev Portal](https://iota.io/developers#dev-tools) using the **Node Service** tab.

:::

## Migrate to version 0.38.0

The IOTA TypeScript SDK was refactored beginning with version 0.38.0. If you are updating from an
Expand Down
Loading