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.

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(docs) : Fix navbar items UI #4155

Draft
wants to merge 4 commits into
base: develop
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
4 changes: 2 additions & 2 deletions apps/wallet/src/ui/app/pages/home/nft-details/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -58,12 +58,12 @@ function NFTDetailsPage() {
const isPending = isNftLoading || isPendingDisplay || isGuardLoading;

function handleMoreAboutKiosk() {
window.open('https://docs.iota.org/references/ts-sdk/kiosk/', '_blank');
window.open('https://docs.iota.org/ts-sdk/kiosk/', '_blank');
}

function handleMarketplace() {
// TODO: https://github.com/iotaledger/iota/issues/4024
window.open('https://docs.iota.org/references/ts-sdk/kiosk/', '_blank');
window.open('https://docs.iota.org/ts-sdk/kiosk/', '_blank');
}

function handleSend() {
Expand Down
2 changes: 1 addition & 1 deletion dapps/multisig-toolkit/src/routes/multisig-address.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,7 @@ export default function MultiSigAddressGenerator() {
<CardHeader>
<CardTitle>IOTA MultiSig Address</CardTitle>
<CardDescription>
https://docs.iota.org/references/ts-sdk/typescript/cryptography/multisig
https://docs.iota.org/ts-sdk/typescript/cryptography/multisig
</CardDescription>
</CardHeader>
<CardContent>
Expand Down
2 changes: 1 addition & 1 deletion docs/content/developer/dev-cheat-sheet.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ Quick reference on best practices for IOTA Network developers.

## Apps

- For optimal performance and data consistency, apps should submit writes and reads for the same full node. In the TS SDK, this means that apps should use the wallet's [`signTransactionBlock`](../references/ts-sdk/dapp-kit/index.mdx) API, then submit the transaction via a call to [`execute_transactionBlock`](/iota-api-ref#iota_executetransactionblock) on the app's full node, _not_ use the wallet's `signAndExecuteTransactionBlock` API. This ensures read-after-write-consistency--reads from the app's full node will reflect writes from the transaction right away instead of waiting for a checkpoint.
- For optimal performance and data consistency, apps should submit writes and reads for the same full node. In the TS SDK, this means that apps should use the wallet's [`signTransactionBlock`](../ts-sdk/dapp-kit/index.mdx) API, then submit the transaction via a call to [`execute_transactionBlock`](/iota-api-ref#iota_executetransactionblock) on the app's full node, _not_ use the wallet's `signAndExecuteTransactionBlock` API. This ensures read-after-write-consistency--reads from the app's full node will reflect writes from the transaction right away instead of waiting for a checkpoint.
- For lower latency, use [`executeTransactionBlock`](/iota-api-ref#iota_executetransactionblock) with `"showEffects": false` and `"showEvents": false` if your app needs to know that a transaction was confirmed, but does not immediately need to see the transaction effects or read the objects/events written by the transaction.
- Apps should implement a local cache for frequently read data rather than over-fetching from the full node.
- Whenever possible, use programmable transaction blocks to compose existing on-chain functionality rather than publishing new smart contract code. Programmable transaction blocks allow large-scale batching and heterogeneous composition, driving already-low gas fees down even further.
Expand Down
2 changes: 1 addition & 1 deletion docs/content/developer/evm-to-move/tooling-apis.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ Unlike with EVM, where open-source third parties create the most used tooling, t

### SDKs

IOTA Move comes with a convenient [Rust](../../references/rust-sdk.mdx) and [TypeScript SDK](../../references/ts-sdk/typescript/index.mdx) right out of the box as part of the IOTA Move core. Next to that, a dApp toolkit is also offered by default, which provides several React components to more easily integrate your IOTA Move contract interaction within your dApp. While TypeScript covers most dApp requirements for an SDK, there might not be an SDK available for your language of choice at the moment. However, You can use one of the APIs directly on a lower level.
IOTA Move comes with a convenient [Rust](../../references/rust-sdk.mdx) and [TypeScript SDK](../../ts-sdk/typescript/index.mdx) right out of the box as part of the IOTA Move core. Next to that, a dApp toolkit is also offered by default, which provides several React components to more easily integrate your IOTA Move contract interaction within your dApp. While TypeScript covers most dApp requirements for an SDK, there might not be an SDK available for your language of choice at the moment. However, You can use one of the APIs directly on a lower level.

### Wallets

Expand Down
4 changes: 2 additions & 2 deletions docs/content/developer/getting-started/client-tssdk.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -34,14 +34,14 @@ yarn create @iota/dapp --template react-client-dapp

## What is the IOTA TypeScript SDK?

The [IOTA TypeScript SDK](../../references/ts-sdk/typescript/index.mdx) (`@iota/iota-sdk`) provides the essential
The [IOTA TypeScript SDK](../../ts-sdk/typescript/index.mdx) (`@iota/iota-sdk`) provides the essential
functionality needed to interact with the IOTA
ecosystem from TypeScript. It's versatile enough to be used in any TypeScript or JavaScript project, including web apps,
Node.js applications, or mobile apps developed with tools like React Native that support TypeScript.

## What is dApp Kit?

[dApp Kit](../../references/ts-sdk/dapp-kit/index.mdx). (`@iota/dapp-kit`) is a collection of React hooks, components,
[dApp Kit](../../ts-sdk/dapp-kit/index.mdx). (`@iota/dapp-kit`) is a collection of React hooks, components,
and utilities designed to simplify building
decentralized applications (dApps) on the IOTA network.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ IOTA nodes.

IOTA provides two official SDKs that you can use to interact with the IOTA network from your dApp:

* [Typescript SDK](../../references/ts-sdk/typescript/index.mdx)
* [Typescript SDK](../../ts-sdk/typescript/index.mdx)
* [Rust SDK](../../references/rust-sdk.mdx)

## Move IDEs and plugins
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -546,7 +546,7 @@ you'll publish this package and then upgrade it to change the value emitted in t
### Using the TypeScript SDK

To publish and upgrade the package using your custom policy,
you'll need to use the [IOTA TypeScript SDK](../../../../references/ts-sdk/typescript/index.mdx).
you'll need to use the [IOTA TypeScript SDK](../../../../ts-sdk/typescript/index.mdx).

#### 1. Set Up a Node.js Project

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import questions from '/json/developer/iota-101/transactions/ptb/building-progra
# Build Programmable Transaction Blocks with TypeScript SDK

This guide illustrates how to build a [programmable transaction block (PTB)](programmable-transaction-blocks.mdx) on IOTA
using the [TypeScript SDK](../../../../references/ts-sdk/typescript/install.mdx).
using the [TypeScript SDK](../../../../ts-sdk/typescript/install.mdx).

This example starts by building a PTB to send IOTA tokens.
To construct transactions, import the `Transaction` class and create a new instance:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ making coin management a crucial step in transaction preparation.

## Using the IOTA SDKs

The IOTA SDKs for [TypeScript](../../../../references/ts-sdk/typescript/index.mdx) and [Rust](../../../../references/rust-sdk.mdx) handle coin management automatically,
The IOTA SDKs for [TypeScript](../../../../ts-sdk/typescript/index.mdx) and [Rust](../../../../references/rust-sdk.mdx) handle coin management automatically,
merging coins as needed and assuming sequential transaction execution.
This automation simplifies the process for most use cases where high concurrency isn't a concern.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ description: Learn about Programmable Transaction Blocks (PTBs) in IOTA and how

## Building PTBs with the TypeScript SDK

To truly harness the capabilities of PTBs, practical experience is key. Utilizing tools like the [IOTA TypeScript SDK](../../../../references/ts-sdk/typescript/index.mdx) allows you to explore the power and flexibility that PTBs offer.
To truly harness the capabilities of PTBs, practical experience is key. Utilizing tools like the [IOTA TypeScript SDK](../../../../ts-sdk/typescript/index.mdx) allows you to explore the power and flexibility that PTBs offer.

Dive deeper into this topic in [Building Programmable Transaction Blocks](building-programmable-transaction-blocks-ts-sdk).

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ Below are examples demonstrating how to sign and submit transactions using Rust,

<TabItem value="typescript" label="TypeScript">

There are several methods to create a key pair and derive its public key and Move address using the [Move TypeScript SDK](../../../references/ts-sdk/typescript/index.mdx).
There are several methods to create a key pair and derive its public key and Move address using the [Move TypeScript SDK](../../../ts-sdk/typescript/index.mdx).

```tsx
import { fromHEX } from '@iota/bcs';
Expand Down
4 changes: 2 additions & 2 deletions docs/content/developer/iota-101/using-events.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ public fun collect_profits( _: &ShopOwnerCap, shop: &mut DonutShop, ctx: &mut Tx
## Subscribing to Events

To react to events emitted by Move modules, you need to subscribe to them.
IOTA full nodes support event subscriptions via JSON-RPC notifications over WebSocket. You can interact with the [RPC directly][iotax_subscribeEvent](/iota-api-ref#iotax_subscribeevent), [iotax_subscribeTransaction](/iota-api-ref#iotax_subscribetransaction) or use an SDK like the [IOTA TypeScript SDK](../../references/ts-sdk/typescript/index.mdx).
IOTA full nodes support event subscriptions via JSON-RPC notifications over WebSocket. You can interact with the [RPC directly][iotax_subscribeEvent](/iota-api-ref#iotax_subscribeevent), [iotax_subscribeTransaction](/iota-api-ref#iotax_subscribetransaction) or use an SDK like the [IOTA TypeScript SDK](../../ts-sdk/typescript/index.mdx).

The following excerpt from one of the examples uses the TypeScript SDK to create an asynchronous subscription to the filter identified in the filter.

Expand Down Expand Up @@ -134,7 +134,7 @@ async fn main() -> Result<()> {

### TypeScript

To create the event subscription, you can use a basic Node.js app. You need the [IOTA TypeScript SDK](../../references/ts-sdk/typescript/index.mdx), so install the module using `npm install @iota/iota-sdk` at the root of your project. In your TypeScript code, import `JsonRpcProvider` and a connection from the library.
To create the event subscription, you can use a basic Node.js app. You need the [IOTA TypeScript SDK](../../ts-sdk/typescript/index.mdx), so install the module using `npm install @iota/iota-sdk` at the root of your project. In your TypeScript code, import `JsonRpcProvider` and a connection from the library.

```ts

Expand Down
2 changes: 1 addition & 1 deletion docs/content/developer/standards/kiosk.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Practically, Kiosk is a part of the IOTA framework, and it is native to the syst

:::info

See the [Kiosk SDK documentation](../../references/ts-sdk/kiosk/index.mdx) for examples of working with Kiosk using TypeScript.
See the [Kiosk SDK documentation](../../ts-sdk/kiosk/index.mdx) for examples of working with Kiosk using TypeScript.

:::

Expand Down
2 changes: 1 addition & 1 deletion docs/content/developer/standards/wallet-standard.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -327,6 +327,6 @@ These values are all arrays containing the new or changed items. Consequently, e

### Implementation Example

IOTA offers a bare bones scaffold for React-based applications called `@iota/dapp-kit`. See the [dApp Kit documentation](../../references/ts-sdk/dapp-kit/index.mdx) for more information.
IOTA offers a bare bones scaffold for React-based applications called `@iota/dapp-kit`. See the [dApp Kit documentation](../../ts-sdk/dapp-kit/index.mdx) for more information.

<Quiz questions={questions} />
2 changes: 1 addition & 1 deletion docs/content/references/references.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ Access IOTA Move functions on chain using the IOTA Move CLI.
Official software development kits (SDKs) available for IOTA include the TypeScript SDK and Rust SDK.

<Cards>
<Card title="IOTA TypeScript SDK" href="references/ts-sdk/typescript">
<Card title="IOTA TypeScript SDK" href="ts-sdk/typescript">
The IOTA TypeScript SDK has its own microsite. Click this box to go there.
</Card>
<Card title="IOTA Rust SDK" href="references/rust-sdk"/>
Expand Down
2 changes: 1 addition & 1 deletion docs/content/sidebars/developer.js
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ const developer = [
{
type: 'link',
label: 'Typescript SDK',
href: '/references/ts-sdk/typescript',
href: '/ts-sdk/typescript',
},
'developer/iota-101/using-events',
],
Expand Down
Loading
Loading