codeesura / scroll-bridge

This repository is a project that interacts with the Ethereum blockchain. It utilizes the ethers.js library to facilitate the transfer of ETH to the scroll L2 network. The repository contains helper functions and configuration files to assist users in sending ETH through a specific bridge. Additionally, it features functionalities such as estimate

📌 Overview

scroll-bridge is a project that utilizes essential dependencies like dotenv, bun-types, and ethers to create a seamless scrolling experience.

🔍 Table of Contents

• 📁 Project Structure

• 📝 Project Summary

• 💻 Stack

• ⚙️ Setting Up

• 🚀 Run Locally

• 🙌 Contributors

• 📄 License

• 📭 Contact

📁 Project Structure

├── .env
├── .gitignore
├── README.md
├── abis
│   ├── BridgeABI.json
│   └── PoolABI.json
├── config
│   └── config.js
├── jsconfig.json
├── package.json
└── src
    ├── helpers
    │   └── contractHelper.js
    └── main.js

📝 Project Summary

• src: Contains the main source code of the JavaScript project.
• config: Includes configuration files for the project.
• src/helpers: Contains helper functions to assist in the main functionalities of the project.
• abis: Stores the Application Binary Interface (ABI) files used for interacting with smart contracts.

💻 Stack

• dotenv: Loads environment variables from a .env file into process.env.
• bun-types: Provides a set of TypeScript type utilities to enhance type safety.
• ethers: A library for interacting with the Ethereum blockchain, including contract interactions and wallet management.

⚙️ Setting Up

Your Environment Variable

To properly set up the scroll-bridge project, follow the steps below:

Environment Variables

The project uses environment variables to manage and keep sensitive information secure. Ensure you configure these before running the application:

• Edit your file: Open .env in your preferred editor. You'll notice several environment variables. Fill in the necessary details for each variable.

Example:

PRIVATE_KEY=your_private_key_here

🚀 Run Locally

1.Clone the scroll-bridge repository:

git clone https://github.com/codeesura/scroll-bridge

2.Install the dependencies with one of the package managers listed below:

bun install

3.Run:

bun src/main.js

🙌 Contributors

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

📭 Contact

If you have any questions about our project, you can reach us at: [e-mail]