{"id":43541466,"url":"https://github.com/matter-labs/zksync-js","last_synced_at":"2026-02-18T13:03:02.477Z","repository":{"id":326244865,"uuid":"1095098448","full_name":"matter-labs/zksync-js","owner":"matter-labs","description":"ZKsync OS JavaScript SDK","archived":false,"fork":false,"pushed_at":"2026-02-12T22:17:17.000Z","size":2373,"stargazers_count":3,"open_issues_count":8,"forks_count":3,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-02-13T03:35:34.091Z","etag":null,"topics":["zksync"],"latest_commit_sha":null,"homepage":"https://matter-labs.github.io/zksync-js/latest/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/matter-labs.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":".github/CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS.md","security":".github/SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":"AGENTS.md","dco":null,"cla":null}},"created_at":"2025-11-12T15:34:32.000Z","updated_at":"2026-02-12T22:07:57.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/matter-labs/zksync-js","commit_stats":null,"previous_names":["matter-labs/zksync-js"],"tags_count":8,"template":false,"template_full_name":null,"purl":"pkg:github/matter-labs/zksync-js","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/matter-labs%2Fzksync-js","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/matter-labs%2Fzksync-js/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/matter-labs%2Fzksync-js/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/matter-labs%2Fzksync-js/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/matter-labs","download_url":"https://codeload.github.com/matter-labs/zksync-js/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/matter-labs%2Fzksync-js/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29580646,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-18T08:38:15.585Z","status":"ssl_error","status_checked_at":"2026-02-18T08:38:14.917Z","response_time":162,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["zksync"],"created_at":"2026-02-03T18:12:18.962Z","updated_at":"2026-02-18T13:03:02.471Z","avatar_url":"https://github.com/matter-labs.png","language":"TypeScript","readme":"\u003cdiv align=\"center\"\u003e\n\n# ⚡️ zksync-js ⚡️\n\n_TypeScript SDK for deposits, withdrawals, and RPC access across the Elastic Network_\n\n[![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)\n[![Release](https://img.shields.io/github/v/release/matter-labs/zksync-js?label=version)](https://github.com/matter-labs/zksync-js/releases/latest)\n[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](LICENSE)\n[![X: @zksync](https://img.shields.io/badge/follow-@zksync-1DA1F2?logo=x)](https://x.com/zksync)\n[![User Book](https://img.shields.io/badge/docs-user%20book-brightgreen)](https://matter-labs.github.io/zksync-js/latest/)\n\n\u003c/div\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003cb\u003e\n    \u003ca href=\"https://matter-labs.github.io/zksync-js/latest/quickstart/index.html\"\u003eQuickstart\u003c/a\u003e ·\n    \u003ca href=\"https://matter-labs.github.io/zksync-js/latest/\"\u003eUser Book\u003c/a\u003e ·\n    \u003ca href=\"./.github/CONTRIBUTING.md\"\u003eContributing\u003c/a\u003e\n  \u003c/b\u003e\n\u003c/p\u003e\n\n## ✨ Features\n\n- **Adapters for both worlds** – choose [`viem`](https://viem.sh) or [`ethers`](https://docs.ethers.io)\n- **Deposits (L1 → L2)** – ETH and ERC-20 transfers\n- **Withdrawals (L2 → L1)** – full two-step flows with status tracking + finalization\n- **zks\\_ RPC methods** – typed helpers for logProofs, receipts, and bridgehub access\n- **Helper methods** – helpers for l1-l2 token address mapping, contract address fetching\n- **Try-methods** – no-throw style (`tryCreate`, `tryWait`) for UI / services\n\n## 📦 Installation\n\nInstall the adapter you need:\n\n\u003cdetails\u003e\n\u003csummary\u003e\u003cstrong\u003eviem adapter\u003c/strong\u003e\u003c/summary\u003e\n\n```bash\nnpm install @matterlabs/zksync-js viem\n```\n\n\u003c/details\u003e\n\n\u003cdetails\u003e\n\u003csummary\u003e\u003cstrong\u003eethers adapter\u003c/strong\u003e\u003c/summary\u003e\n\n```bash\nnpm install @matterlabs/zksync-js ethers\n```\n\n\u003c/details\u003e\n\n## ⚡️ Quick-start\n\nFor exhaustive examples please refer to [`./examples`](./examples/) directory.\n\n**ETH deposit (ethers)**\n\n```ts\nimport { JsonRpcProvider, Wallet, parseEther } from 'ethers';\nimport { createEthersClient, createEthersSdk } from '@matterlabs/zksync-js/ethers';\nimport { ETH_ADDRESS } from '@matterlabs/zksync-js/core';\n\nconst l1Provider = new JsonRpcProvider('https://sepolia.infura.io/v3/...');\nconst l2Provider = new JsonRpcProvider('https://zksync-testnet.rpc');\nconst signer = new Wallet(process.env.PRIVATE_KEY!, l1Provider);\n\nconst client = await createEthersClient({ l1Provider, l2Provider, signer });  \nconst sdk = createEthersSdk(client);\n\nconst deposit = await sdk.deposits.create({\n  token: ETH_ADDRESS,\n  amount: parseEther('0.01'),\n  to: signer.address,\n});\n\nawait sdk.deposits.wait(handle, { for: 'l2' });\nconsole.log('Deposit complete ✅');\n```\n\n**ETH deposit (viem)**\n\n```ts\nimport { createPublicClient, createWalletClient, http, parseEther } from 'viem';\nimport { createViemClient, createViemSdk } from '@matterlabs/zksync-js/viem';\nimport { ETH_ADDRESS } from '@matterlabs/zksync-js/core';\n\nconst l1 = createPublicClient({ transport: http('https://sepolia.infura.io/v3/...') });\nconst l2 = createPublicClient({ transport: http('https://zksync-testnet.rpc') });\nconst l1Wallet = createWalletClient({\n  account,\n  transport: http('https://sepolia.infura.io/v3/...'),\n});\nconst client = createViemClient({ l1, l2, l1Wallet });\nconst sdk = createViemSdk(client);\n\nconst handle = await sdk.deposits.create({\n  token: ETH_ADDRESS,\n  amount: parseEther('0.01'),\n  to: account.address,\n});\n\nawait sdk.deposits.wait(handle, { for: 'l2' });\nconsole.log('Deposit complete ✅');\n```\n\n\u003e See [Quickstart docs](https://matter-labs.github.io/zksync-js/latest/quickstart/index.html) for full examples.\n\n## 📚 Documentation\n\n- [User Book](https://matter-labs.github.io/zksync-js/latest/) – guides, concepts, API docs\n- [How-to Guides](https://matter-labs.github.io/zksync-js/latest/guides/index.html) – deposits, withdrawals, RPC helpers\n- [Mental Model](https://matter-labs.github.io/zksync-js/latest/overview/mental-model.html) – mental model, status vs wait, finalization\n\n## 🤝 Contributing\n\nBug reports, fixes, and new features are welcome! Please read the [contributing guide](.github/CONTRIBUTING.md) to get started.\n\n## 📜 License\n\nThis project is licensed under the terms of the **MIT License** – see the [LICENSE](LICENSE) file for details.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmatter-labs%2Fzksync-js","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmatter-labs%2Fzksync-js","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmatter-labs%2Fzksync-js/lists"}