Skip to content

Commit 651d2c8

Browse files
dutterbutterdutterbutter
authored
fix: update docs (#10)
* fix: update docs * fix: readme
1 parent 19d7072 commit 651d2c8

38 files changed

+81
-81
lines changed

‎README.md‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -10,14 +10,14 @@ _TypeScript SDK for deposits, withdrawals, and RPC access across the Elastic Net
1010
[![Release](https://img.shields.io/github/v/release/matter-labs/zksync-js?label=version)](https://github.com/matter-labs/zksync-js/releases/latest)
1111
[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](LICENSE)
1212
[![X: @zksync](https://img.shields.io/badge/follow-@zksync-1DA1F2?logo=x)](https://x.com/zksync)
13-
[![User Book](https://img.shields.io/badge/docs-user%20book-brightgreen)](https://matter-labs.github.io/zksync-js/)
13+
[![User Book](https://img.shields.io/badge/docs-user%20book-brightgreen)](https://matter-labs.github.io/zksync-js/latest/)
1414

1515
</div>
1616

1717
<p align="center">
1818
<b>
19-
<a href="https://matter-labs.github.io/zksync-js/latest/quickstart/">Quickstart</a> ·
20-
<a href="https://matter-labs.github.io/zksync-js/">User Book</a> ·
19+
<a href="https://matter-labs.github.io/zksync-js/latest/quickstart/index.html">Quickstart</a> ·
20+
<a href="https://matter-labs.github.io/zksync-js/latest/">User Book</a> ·
2121
<a href="./.github/CONTRIBUTING.md">Contributing</a>
2222
</b>
2323
</p>
@@ -39,7 +39,7 @@ Install the adapter you need:
3939
<summary><strong>viem adapter</strong></summary>
4040

4141
```bash
42-
npm install @matter-labs/zksync-js viem
42+
npm install @matterlabs/zksync-js viem
4343
```
4444

4545
</details>
@@ -48,7 +48,7 @@ npm install @matter-labs/zksync-js viem
4848
<summary><strong>ethers adapter</strong></summary>
4949

5050
```bash
51-
npm install @matter-labs/zksync-js ethers
51+
npm install @matterlabs/zksync-js ethers
5252
```
5353

5454
</details>
@@ -61,8 +61,8 @@ For exhaustive examples please refer to [`./examples`](./examples/) directory.
6161

6262
```ts
6363
import { JsonRpcProvider, Wallet, parseEther } from 'ethers';
64-
import { createEthersClient, createEthersSdk } from '@matter-labs/zksync-js/ethers';
65-
import { ETH_ADDRESS } from '@matter-labs/zksync-js/core';
64+
import { createEthersClient, createEthersSdk } from '@matterlabs/zksync-js/ethers';
65+
import { ETH_ADDRESS } from '@matterlabs/zksync-js/core';
6666

6767
const l1Provider = new JsonRpcProvider('https://sepolia.infura.io/v3/...');
6868
const l2Provider = new JsonRpcProvider('https://zksync-testnet.rpc');
@@ -85,8 +85,8 @@ console.log('Deposit complete ✅');
8585

8686
```ts
8787
import { createPublicClient, createWalletClient, http, parseEther } from 'viem';
88-
import { createViemClient, createViemSdk } from '@matter-labs/zksync-js/viem';
89-
import { ETH_ADDRESS } from '@matter-labs/zksync-js/core';
88+
import { createViemClient, createViemSdk } from '@matterlabs/zksync-js/viem';
89+
import { ETH_ADDRESS } from '@matterlabs/zksync-js/core';
9090

9191
const l1 = createPublicClient({ transport: http('https://sepolia.infura.io/v3/...') });
9292
const l2 = createPublicClient({ transport: http('https://zksync-testnet.rpc') });
@@ -111,9 +111,9 @@ console.log('Deposit complete ✅');
111111
112112
## 📚 Documentation
113113

114-
- [User Book](https://matter-labs.github.io/zksync-sdk/) – guides, concepts, API docs
115-
- [How-to Guides](https://matter-labs.github.io/zksync-sdk/guides/) – deposits, withdrawals, RPC helpers
116-
- [Concepts](https://matter-labs.github.io/zksync-sdk/concepts/) – mental model, status vs wait, finalization
114+
- [User Book](https://matter-labs.github.io/zksync-js/latest/) – guides, concepts, API docs
115+
- [How-to Guides](https://matter-labs.github.io/zksync-js/latest/guides/index.html) – deposits, withdrawals, RPC helpers
116+
- [Mental Model](https://matter-labs.github.io/zksync-js/latest/overview/mental-model.html) – mental model, status vs wait, finalization
117117

118118
## 🤝 Contributing
119119

‎docs/snippets/ethers/deposit-erc20.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
// examples/deposit-erc20.ts
22
import { JsonRpcProvider, Wallet, parseUnits, type Signer } from 'ethers';
3-
import { createEthersClient, createEthersSdk } from '@matter-labs/zksync-js/ethers';
3+
import { createEthersClient, createEthersSdk } from '@matterlabs/zksync-js/ethers';
44

55
const L1_RPC = 'http://localhost:8545'; // e.g. https://sepolia.infura.io/v3/XXX
66
const L2_RPC = 'http://localhost:3050'; // your L2 RPC

‎docs/snippets/ethers/deposit-eth.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
// examples/deposit-eth.ts
22
import { JsonRpcProvider, Wallet, parseEther } from 'ethers';
3-
import { createEthersClient, createEthersSdk } from '@matter-labs/zksync-js/ethers';
4-
import { ETH_ADDRESS } from '@matter-labs/zksync-js/core';
3+
import { createEthersClient, createEthersSdk } from '@matterlabs/zksync-js/ethers';
4+
import { ETH_ADDRESS } from '@matterlabs/zksync-js/core';
55

66
const L1_RPC = 'http://localhost:8545'; // e.g. https://sepolia.infura.io/v3/XXX
77
const L2_RPC = 'http://localhost:3050'; // your L2 RPC

‎docs/snippets/ethers/withdrawals-erc20.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
// examples/withdrawals-erc20.ts
22
import { JsonRpcProvider, Wallet, parseUnits } from 'ethers';
3-
import { createEthersClient, createEthersSdk } from '@matter-labs/zksync-js/ethers';
3+
import { createEthersClient, createEthersSdk } from '@matterlabs/zksync-js/ethers';
44

55
const L1_RPC = 'http://localhost:8545'; // e.g. https://sepolia.infura.io/v3/XXX
66
const L2_RPC = 'http://localhost:3050'; // your L2 RPC

‎docs/snippets/ethers/withdrawals-eth.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
// examples/withdrawals-eth.ts
22
import { JsonRpcProvider, Wallet, parseEther } from 'ethers';
3-
import { createEthersClient, createEthersSdk } from '@matter-labs/zksync-js/ethers';
4-
import { ETH_ADDRESS } from '@matter-labs/zksync-js/core';
3+
import { createEthersClient, createEthersSdk } from '@matterlabs/zksync-js/ethers';
4+
import { ETH_ADDRESS } from '@matterlabs/zksync-js/core';
55

66
const L1_RPC = 'http://localhost:8545'; // e.g. https://sepolia.infura.io/v3/XXX
77
const L2_RPC = 'http://localhost:3050'; // your L2 RPC

‎docs/snippets/viem/deposit-erc20.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ import {
1010
WalletClient,
1111
} from 'viem';
1212
import { privateKeyToAccount } from 'viem/accounts';
13-
import { createViemSdk, createViemClient } from '@matter-labs/zksync-js/viem';
13+
import { createViemSdk, createViemClient } from '@matterlabs/zksync-js/viem';
1414

1515
const L1_RPC = 'http://localhost:8545'; // e.g. https://sepolia.infura.io/v3/XXX
1616
const L2_RPC = 'http://localhost:3050'; // your L2 RPC

‎docs/snippets/viem/deposit-eth.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@ import { createPublicClient, createWalletClient, http, parseEther, WalletClient
33
import type { Account, Chain, Transport } from 'viem';
44
import { privateKeyToAccount } from 'viem/accounts';
55

6-
import { createViemSdk, createViemClient } from '@matter-labs/zksync-js/viem';
7-
import { ETH_ADDRESS } from '@matter-labs/zksync-js/core';
6+
import { createViemSdk, createViemClient } from '@matterlabs/zksync-js/viem';
7+
import { ETH_ADDRESS } from '@matterlabs/zksync-js/core';
88

99
const L1_RPC = 'http://localhost:8545'; // e.g. https://sepolia.infura.io/v3/XXX
1010
const L2_RPC = 'http://localhost:3050'; // your L2 RPC

‎docs/snippets/viem/withdrawals-erc20.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ import {
1010
type WalletClient,
1111
} from 'viem';
1212
import { privateKeyToAccount } from 'viem/accounts';
13-
import { createViemSdk, createViemClient } from '@matter-labs/zksync-js/viem';
13+
import { createViemSdk, createViemClient } from '@matterlabs/zksync-js/viem';
1414

1515
const L1_RPC = 'http://localhost:8545'; // e.g. https://sepolia.infura.io/v3/XXX
1616
const L2_RPC = 'http://localhost:3050'; // your L2 RPC

‎docs/snippets/viem/withdrawals-eth.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ import {
1010
} from 'viem';
1111
import { privateKeyToAccount, nonceManager } from 'viem/accounts';
1212

13-
import { createViemSdk, createViemClient } from '@matter-labs/zksync-js/viem';
14-
import { ETH_ADDRESS } from '@matter-labs/zksync-js/core';
13+
import { createViemSdk, createViemClient } from '@matterlabs/zksync-js/viem';
14+
import { ETH_ADDRESS } from '@matterlabs/zksync-js/core';
1515

1616
const L1_RPC = 'http://localhost:8545'; // e.g. https://sepolia.infura.io/v3/XXX
1717
const L2_RPC = 'http://localhost:3050'; // your L2 RPC

‎docs/src/guides/deposits/ethers.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ A fast path to deposit **ETH / ERC-20** from L1 → ZKsync (L2) using the **ethe
66

77
- A funded **L1** account (gas + amount).
88
- RPC URLs: `L1_RPC_URL`, `L2_RPC_URL`.
9-
- Installed: `@matter-labs/zksync-js` + `ethers`.
9+
- Installed: `@matterlabs/zksync-js` + `ethers`.
1010

1111
---
1212

0 commit comments

Comments
 (0)