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

Docs: link fixes #555

Merged
merged 3 commits into from
Dec 13, 2024
Merged
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
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/1-introduction.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ Arbitrum SDK comes pre-configured for Mainnet and Sepolia, and their Arbitrum co

#### Configuring Network

To interact with a custom [`ArbitrumNetwork`](./reference/dataEntities/networks), you can register it using the [`registerCustomArbitrumNetwork`](./reference/dataEntities/networks.md#registerCustomArbitrumNetwork) function.
To interact with a custom [`ArbitrumNetwork`](./reference/dataEntities/networks), you can register it using the [`registerCustomArbitrumNetwork`](./reference/dataEntities/networks.md#registercustomarbitrumnetwork) function.

```ts
import { registerCustomArbitrumNetwork } from '@arbitrum/sdk'
Expand Down
10 changes: 5 additions & 5 deletions docs/2-migrate.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -25,15 +25,15 @@ Most instances of "L1" and "L2" have been replaced with "parent" and "child" res
- The `L1Network` is no longer required to be registered before bridging.
- Only Arbitrum networks need to be registered.
- Arbitrum networks are defined as Arbitrum One, Arbitrum testnets, and any Orbit chain.
- If you need a full list of Arbitrum networks, you can use the new [`getArbitrumNetworks`](./reference/dataEntities/networks#getArbitrumNetworks) function.
- To list all of the children of a network, use the new [`getChildrenForNetwork`](./reference/dataEntities/networks#getChildrenForNetwork) function.
- If you need a full list of Arbitrum networks, you can use the new [`getArbitrumNetworks`](./reference/dataEntities/networks#getarbitrumnetworks) function.
- To list all of the children of a network, use the new [`getChildrenForNetwork`](./reference/dataEntities/networks#getchildrenfornetwork) function.

| v3 Name | v4 Name |
| --------------------- | -------------------------------------------------------------------------------------------------- |
| `L2Network` | [`ArbitrumNetwork`](./reference/dataEntities/networks#arbitrumnetwork) |
| `getL2Network` | [`getArbitrumNetwork`](./reference/dataEntities/networks#getArbitrumNetwork) |
| `l2Networks` | [`getArbitrumNetworks`](./reference/dataEntities/networks#getArbitrumNetworks) |
| `addCustomNetwork` | [`registerCustomArbitrumNetwork`](./reference/dataEntities/networks#registerCustomArbitrumNetwork) |
| `getL2Network` | [`getArbitrumNetwork`](./reference/dataEntities/networks#getarbitrumnetwork) |
| `l2Networks` | [`getArbitrumNetworks`](./reference/dataEntities/networks#getarbitrumnetworks) |
| `addCustomNetwork` | [`registerCustomArbitrumNetwork`](./reference/dataEntities/networks#registercustomarbitrumnetwork) |
| `Network` | *removed* |
| `L1Network` | *removed* |
| `getL1Network` | *removed* |
Expand Down
Loading