@matterlabs/zksync-js 0.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Dustin Brickwood
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,124 @@
+<div align="center">
+
+# ⚡️ zksync-js ⚡️
+
+_TypeScript SDK for deposits, withdrawals, and RPC access across the Elastic Network_
+
+**Note**: This repository is a successor to the original ZKsync SDK, which can be found at **[dutterbutter/zksync-sdk](https://github.com/dutterbutter/zksync-sdk)**.
+
+[![CI Status](https://github.com/matter-labs/zksync-js/actions/workflows/ci-check.yaml/badge.svg)](https://github.com/matter-labs/zksync-js/actions/workflows/ci-check.yaml)
+[![Release](https://img.shields.io/github/v/release/matter-labs/zksync-js?label=version)](https://github.com/matter-labs/zksync-js/releases/latest)
+[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](LICENSE)
+[![X: @zksync](https://img.shields.io/badge/follow-@zksync-1DA1F2?logo=x)](https://x.com/zksync)
+[![User Book](https://img.shields.io/badge/docs-user%20book-brightgreen)](https://matter-labs.github.io/zksync-js/)
+
+</div>
+
+<p align="center">
+  <b>
+    <a href="https://matter-labs.github.io/zksync-js/latest/quickstart/">Quickstart</a> ·
+    <a href="https://matter-labs.github.io/zksync-js/">User Book</a> ·
+    <a href="./.github/CONTRIBUTING.md">Contributing</a>
+  </b>
+</p>
+
+## ✨ Features
+
+- **Adapters for both worlds** – choose [`viem`](https://viem.sh) or [`ethers`](https://docs.ethers.io)
+- **Deposits (L1 → L2)** – ETH and ERC-20 transfers
+- **Withdrawals (L2 → L1)** – full two-step flows with status tracking + finalization
+- **zks\_ RPC methods** – typed helpers for logProofs, receipts, and bridgehub access
+- **Helper methods** – helpers for l1-l2 token address mapping, contract address fetching
+- **Try-methods** – no-throw style (`tryCreate`, `tryWait`) for UI / services
+
+## 📦 Installation
+
+Install the adapter you need:
+
+<details>
+<summary><strong>viem adapter</strong></summary>
+
+```bash
+npm install @matter-labs/zksync-js viem
+```
+
+</details>
+
+<details>
+<summary><strong>ethers adapter</strong></summary>
+
+```bash
+npm install @matter-labs/zksync-js ethers
+```
+
+</details>
+
+## ⚡️ Quick-start
+
+For exhaustive examples please refer to [`./examples`](./examples/) directory.
+
+**ETH deposit (ethers)**
+
+```ts
+import { JsonRpcProvider, Wallet, parseEther } from 'ethers';
+import { createEthersClient, createEthersSdk } from '@matter-labs/zksync-js/ethers';
+import { ETH_ADDRESS } from '@matter-labs/zksync-js/core';
+
+const l1Provider = new JsonRpcProvider('https://sepolia.infura.io/v3/...');
+const l2Provider = new JsonRpcProvider('https://zksync-testnet.rpc');
+const signer = new Wallet(process.env.PRIVATE_KEY!, l1Provider);
+
+const client = await createEthersClient({ l1Provider, l2Provider, signer });  
+const sdk = createEthersSdk(client);
+
+const deposit = await sdk.deposits.create({
+  token: ETH_ADDRESS,
+  amount: parseEther('0.01'),
+  to: signer.address,
+});
+
+await sdk.deposits.wait(handle, { for: 'l2' });
+console.log('Deposit complete ✅');
+```
+
+**ETH deposit (viem)**
+
+```ts
+import { createPublicClient, createWalletClient, http, parseEther } from 'viem';
+import { createViemClient, createViemSdk } from '@matter-labs/zksync-js/viem';
+import { ETH_ADDRESS } from '@matter-labs/zksync-js/core';
+
+const l1 = createPublicClient({ transport: http('https://sepolia.infura.io/v3/...') });
+const l2 = createPublicClient({ transport: http('https://zksync-testnet.rpc') });
+const l1Wallet = createWalletClient({
+  account,
+  transport: http('https://sepolia.infura.io/v3/...'),
+});
+const client = createViemClient({ l1, l2, l1Wallet });
+const sdk = createViemSdk(client);
+
+const handle = await sdk.deposits.create({
+  token: ETH_ADDRESS,
+  amount: parseEther('0.01'),
+  to: account.address,
+});
+
+await sdk.deposits.wait(handle, { for: 'l2' });
+console.log('Deposit complete ✅');
+```
+
+> See [Quickstart docs](https://matter-labs.github.io/zksync-js/quickstart/) for full examples.
+
+## 📚 Documentation
+
+- [User Book](https://matter-labs.github.io/zksync-sdk/) – guides, concepts, API docs
+- [How-to Guides](https://matter-labs.github.io/zksync-sdk/guides/) – deposits, withdrawals, RPC helpers
+- [Concepts](https://matter-labs.github.io/zksync-sdk/concepts/) – mental model, status vs wait, finalization
+
+## 🤝 Contributing
+
+Bug reports, fixes, and new features are welcome! Please read the [contributing guide](.github/CONTRIBUTING.md) to get started.
+
+## 📜 License
+
+This project is licensed under the terms of the **MIT License** – see the [LICENSE](LICENSE) file for details.