Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
  • Loading branch information
schoad committed Jan 15, 2025
2 parents 0b5573c + 51cf8b2 commit 42c8a3e
Show file tree
Hide file tree
Showing 2 changed files with 87 additions and 0 deletions.
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2025 schoad.eth

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.
66 changes: 66 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
# COSMOS Auction Viewer

**COSMOS** is a simple web application designed to display real-time information about an ongoing Ethereum-based auction for the COSMOS project. This application leverages blockchain technology to fetch and display auction details directly from a smart contract.

## Features

- **Auction Timer**: Shows the remaining time of the current auction in real-time.
- **Bid Leaderboard**: Displays the top bids in a table format, including:
- Bid Rank
- Bid Amount in ETH
- Bidder's Address or ENS Name (if connected to a wallet)
- **User Interaction**:
- **Connect Wallet**: Users can connect their Ethereum wallet (e.g., MetaMask) to interact with the auction.
- **User Bid Information**: Once connected, users can see their own bid details directly on the page.

## How It Works

- **Without Wallet Connection**:
- The website fetches auction data through an Infura node, showing the auction timer and bid leaderboard with truncated Ethereum addresses.

- **With Wallet Connection**:
- Users can connect their wallet to see their personal bid information.
- ENS names are resolved for addresses when a wallet is connected, providing a more user-friendly display of bidder identities.

## Setup & Usage

1. **Clone the Repository**:
git clone https://github.com/schoad/cosmos-auctions

2. **Install Dependencies**:
- This project uses no backend, but you might need to update or install npm packages if there are any JavaScript dependencies:
npm install

3. **Run the Application**:
- Open the `index.html` file in a web browser that supports JavaScript and Web3 wallets like MetaMask.

4. **Wallet Integration**:
- Install a Web3 wallet like MetaMask.
- Connect your wallet on the website to interact with your auction participation.

## Technologies Used

- **HTML5** for structure
- **CSS3** for styling
- **JavaScript** with:
- **Ethers.js** for interacting with wallet & Ethereum blockchain

## Contributing

Contributions are welcome! Please follow these steps:

- Fork the repository
- Create your feature branch (`git checkout -b feature/AmazingFeature`)
- Commit your changes (`git commit -m 'Add some AmazingFeature'`)
- Push to the branch (`git push origin feature/AmazingFeature`)
- Open a pull request

## License

This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details.

## Disclaimer

This application, COSMOS Auction Viewer, is a community contribution and is not an official product of the Renga team. It is developed and maintained by independent community members with no direct affiliation to or endorsement from the official Renga project or its developers.

Please use this tool at your own risk. The creators of this application are not responsible for any losses, damages, or misrepresentations arising from its use. Always verify information independently and consult official sources for the most accurate and up-to-date information related to the Renga auction or project.

0 comments on commit 42c8a3e

Please sign in to comment.