{"id":18357279,"url":"https://github.com/nethermindeth/zksync-remix-plugin","last_synced_at":"2025-04-06T13:31:16.288Z","repository":{"id":209892734,"uuid":"694218704","full_name":"NethermindEth/zksync-remix-plugin","owner":"NethermindEth","description":"Remix plugin for zkSync","archived":true,"fork":false,"pushed_at":"2024-12-06T07:52:28.000Z","size":52862,"stargazers_count":13,"open_issues_count":39,"forks_count":13,"subscribers_count":10,"default_branch":"develop","last_synced_at":"2025-03-05T09:45:52.101Z","etag":null,"topics":["nubia"],"latest_commit_sha":null,"homepage":null,"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/NethermindEth.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"docs/CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-09-20T14:59:17.000Z","updated_at":"2025-01-10T20:41:39.000Z","dependencies_parsed_at":"2024-02-27T11:08:50.361Z","dependency_job_id":"f943b81b-d8e0-44b9-9234-f892b6ae2fff","html_url":"https://github.com/NethermindEth/zksync-remix-plugin","commit_stats":null,"previous_names":["nethermindeth/zksync-remix-plugin"],"tags_count":10,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NethermindEth%2Fzksync-remix-plugin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NethermindEth%2Fzksync-remix-plugin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NethermindEth%2Fzksync-remix-plugin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NethermindEth%2Fzksync-remix-plugin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/NethermindEth","download_url":"https://codeload.github.com/NethermindEth/zksync-remix-plugin/tar.gz/refs/heads/develop","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247488430,"owners_count":20946945,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":["nubia"],"created_at":"2024-11-05T22:13:18.411Z","updated_at":"2025-04-06T13:31:16.278Z","avatar_url":"https://github.com/NethermindEth.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# zkSync Remix Plugin\n\n\u003e [!IMPORTANT]  \n\u003e The development of ZKsync Remix plugin has been moved to [a new repository](https://github.com/matter-labs/zksync-remix-plugin).\n\u003e This repository is no longer active. Please open issues and pull requests in the new repository.\n\n---\n\nWelcome to the **zkSync Remix Plugin** repository! 🎉\n\nThis tool seamlessly integrates with the Remix IDE, enabling developers to effortlessly deploy and interact with zkSync\ncontracts.\n\u003cdetails\u003e \n\u003csummary\u003eTable of Contents\u003c/summary\u003e\n\n- [zkSync Remix Plugin](#zksync-remix-plugin)\n    - [For users](#for-users)\n        - [Getting Started](#getting-started)\n    - [For Developers](#for-developers)\n        - [Installation](#installation)\n            - [API](#api)\n            - [Plugin](#plugin)\n            - [Running the development environment](#running-the-development-environment)\n                - [Connecting the plugin](#connecting-the-plugin)\n    - [Support and Contributions](#support-and-contributions)\n\n\u003c/details\u003e\n\n## For users\n\nIf you're looking to utilize the capabilities of zkSync contracts within the Remix IDE, you've come to the right place.\nThis section provides you with a straightforward guide to get started.\n\n### Getting Started\n\n\u003c!-- TODO: temporary link --\u003e\n\n1. **Installation**: Get excited, folks, no complicated installations needed here! If you're a user, all you have to do\n   is head over to the Remix IDE and locate the zkSync Remix Plugin in the plugins section. Want to make it even\n   simpler? Click right through to Remix using [this direct link](https://remix.ethereum.org/#activate=zkSync) and\n   you're good to go! 🎉\n\n2. **Usage**: Once the plugin is activated, you'll find a user-friendly interface that allows you to deploy and interact\n   with zkSync contracts. Follow the on-screen prompts and tooltips for an effortlessly smooth experience!\n\n3. **Feedback**: Your feedback is invaluable to us 🌟! If you encounter any issues or have game-changing suggestions,\n   don't hesitate to reach out through\n   our [Community Forum](https://github.com/zkSync-Community-Hub/zkync-developers/discussions/new?category=remix-plugin).\n   Let's make something awesome together! 🤝\n\n## For Developers\n\n### Installation\n\n#### API\n\nOur API is built with [Rocket](https://rocket.rs/), a web framework for Rust. So, you'll need to get Rust and Cargo on\nyour machine to get started. 🛠️\n\nThe easiest way to install Rust and Cargo is by using [rustup](https://rustup.rs/). It's\nthe [recommended tool](https://www.rust-lang.org/tools/install) for managing Rust versions and associated tools for your\nproject.\n\nThen:\n\n```bash\ncd api\ncd hardhat_env\nyarn\ncd ..\nVITE_URL=http://localhost:3000 SERVICE_VERSION=\"v0.1.1\" cargo run\n```\n\n#### Plugin\n\nThe plugin it self is a React project, you'll need to install [pnpm](https://pnpm.io/installation#using-npm).\n\n```bash\ncd plugin;\npnpm install;\n```\n\n#### Running the development environment\n\nFirstly, you need to define ENV variables for the server:\n\n- VITE_URL=http://localhost:3000 - the address of the UI\n- SERVICE_VERSION=\"v0.0.1\" - the version of the back-end (should be less than version of UI)\n\nAnd ENV variables for the plugin:\n\n- API_SERVICE_URL=\"http://0.0.0.0:8000\" - the address of the API\n- WALLETCONNECT_PROJECT_ID=\u003cyour_walletconnect_project_id\u003e - the project id for WalletConnect\n- ZKSYNC_DEVNET_URL=\"https://zksync-devnet.nethermind.dev\" - the address of the StarkNet devnet\n\nYou need to be running both the server and the plugin in order to have a working environment.\n\nFor your dev environment:\n\n```bash\ncd plugin;\npnpm run start;\n```\n\nFor an optimized build (will not listen to changes):\n\n```\npnpm run deploy;\npnpm run serve;\n```\n\n```bash\ncd api\ncd hardhat_env\nyarn\ncd ..\nVITE_URL=http://localhost:3000 SERVICE_VERSION=\"v0.1.1\" cargo run\n```\n\nor alternatively, you can run the server in watch mode (with `cargo watch`):\n\n```bash\ncargo install cargo-watch;\ncargo watch -x run;\n```\n\n##### Connecting the plugin\n\nIn [Remix](http://remix-alpha.ethereum.org/), go to the `Plugin Manager` at the bottom of the left panel, and click\non `Connect to a Local Plugin`.\n\nThen, chose a name for the plugin, and in the `URL` field, enter `http://localhost:3000`, the `Type of Connection`\nshould `iframe` and the `Location in remix` `Side Panel` and click on `Ok`.\n\nYou should be all set to see the magic happen! Activate the plugin and it should now be visible and ready to be hacked\nwith! 🚀\n\n## Support and Contributions\n\nFeel free to contribute! Spotted any [issues](https://github.com/NethermindEth/zksync-remix-plugin/issues)? Head on over\nto\nour [good first issues](https://github.com/NethermindEth/zksync-remix-plugin/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22)\nor read through our [Contribution Guidelines](/docs/CONTRIBUTING.md) to get started. 📝\n\nJump into our [Discord channel](https://discord.com/invite/PaCMRFdvWT) and join our\nthriving [community](https://community.nethermind.io/)! Connect with other users, share insights, and get all your\nquestions answered. Our community is always eager to help newcomers! 🤝\n\nWe're thrilled for you to experience the zkSync Remix Plugin, and we can't wait to see the inventive ways you'll engage\nwith zkSync contracts! Happy coding! 💡\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnethermindeth%2Fzksync-remix-plugin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnethermindeth%2Fzksync-remix-plugin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnethermindeth%2Fzksync-remix-plugin/lists"}