Skip to content

EscrowNet/escrownet-dapp

Repository files navigation

EscrowNet - Decentralized Escrow Platform on Starknet

Overview

EscrowNet is a decentralized application (dApp) and API that enables secure escrow payments on the Starknet network. It provides a trustless environment for conducting transactions between parties by holding assets in escrow until predefined conditions are met.

Features

  • Secure escrow smart contracts on Starknet
  • User-friendly web interface for managing escrow transactions
  • RESTful API for integration with other applications
  • Support for multiple asset types
  • Real-time transaction status monitoring
  • Automated release of funds upon condition fulfillment
  • Multi-signature security for large transactions

Prerequisites

  • Node.js (v16.0 or higher)
  • Yarn or npm package manager
  • Starknet wallet (e.g., ArgentX, Braavos)
  • Git

Installation

  1. Clone the repository:
git clone https://github.com/<yourusername>/escrownet.git
cd escrownet
  1. Install dependencies:
npm install
# or
yarn install
  1. Configure environment variables:
cp .env.example .env.local

Edit .env.local with your configuration details.

Development

Start the development server:

npm run dev
# or
yarn dev
# or
pnpm dev
# or
bun dev

The application will be available at http://localhost:3000.

Smart Contract Integration

The dApp interacts with Starknet smart contracts.

Detailed instructions can be found in the Escrownet-contracts.

API Documentation

The EscrowNet API provides endpoints for:

  • Creating escrow transactions
  • Monitoring transaction status
  • Managing conditions and releases
  • User authentication

For detailed API documentation, refer to Escrownet-backend

Security Considerations

  • Audited smart contracts
  • Multi-signature requirement for high-value transactions
  • Time-locked escrow releases
  • Emergency pause functionality
  • Regular security updates

Testing

Run the test suite:

npm run test
# or
yarn test

Contributing

We welcome contributions! Please follow these steps:

  1. Fork the repository
  2. Create a feature branch
  3. Commit your changes
  4. Push to your branch
  5. Create a Pull Request

Please read our Contributing Guidelines for more details.

License

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

Support

Acknowledgments


Project Status

Current Version: 1.0.0 Status: Beta Release

This project is actively maintained. For the latest updates, follow our changelog.

About

Escrownet frontend

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages