> For the complete documentation index, see [llms.txt](https://colle-1.gitbook.io/colle-marketplace-contracts/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://colle-1.gitbook.io/colle-marketplace-contracts/1_overview.md).

# Contracts Overview

Welcome to a comprehensive technical guide on the Colle marketplace smart contracts. This repository serves as an enlightening resource for those interested in understanding the underpinnings of our protocol.

## The Foundation of Colle: Web3 & Polygon

Colle uses web3 and Polygon to establish a secure, transparent, and user-friendly luxury watch marketplace. Key advantages include:

* **Scalability:** A robust infrastructure built to handle high-demand operations.
* **Eco-friendly:** An energy-efficient blockchain that minimizes the carbon footprint.
* **Compatibility:** Seamless integration with various web3 tools and assets.

Our unique fusion of advanced technology, environmental sustainability, and superior user experience defines a new era for luxury watch trading.

## Secure and Versatile Sign-in Options

Colle offers a secure sign-in process based on Ethereum's framework, providing various methods suitable for different user levels:

* **MagicLink:** A beginner-friendly, email-based option for creating a web3 wallet.
* **MetaMask:** A browser plugin for experienced users to manage their assets securely.
* **WalletConnect:** A bridge for mobile wallet users to use their preferred wallets.

These options ensure users maintain full control over their assets within a secure environment.

## Solidity Smart Contracts

The Colle marketplace utilizes Solidity smart contracts to facilitate secure and transparent interactions:

* **NFTs - ERC721 Compatible:** This contract governs the minting, ownership, and transfer of luxury watch NFTs.
* **Market Contracts:** These contracts enable core functionalities, allowing users to list, make offers, and transact for luxury watch NFTs.
* **Royalties Contracts:** These contracts automate the distribution of royalties from each sale, creating a transparent and fair system.
* **Team Smart Wallets:** On-chain wallets directly integrated with the marketplace, allowing members of a team to interact based on their assigned roles.

Colle employs a hybrid approach of modular and upgradeable contracts. Modular contracts enable us to extend future functionality, such as adding new types of markets, supporting more ERC20 currencies, and creating a dynamic royalty/commission system based on seller tiers. Upgradeable contracts allow us to enhance the functionality of select modules without needing to replace them entirely.

## NFT Contract Overview

Colle's custom NFTs offer a secure and user-friendly environment, allowing luxury watch collectors to trade timepieces while enjoying the benefits of blockchain technology.

* **ERC721 Compatibility:** Public details are stored securely on the decentralized IPFS, maintaining transparency and tamper-proof information.
* **Exclusive Use:** Our NFTs are designed to be unusable in third-party marketplaces, ensuring their uniqueness within the Colle ecosystem.
* **Gasless Experience:** Several permit functions have been added to our NFTs, enabling users to interact without incurring gas fees.

## Exclusive, Invite-Only Access

Colle is an exclusive platform that operates on an invite-only basis, ensuring that every participant is carefully vetted. This exclusive community promotes a high-quality, secure marketplace for luxury watch enthusiasts to buy, sell, and trade.

## Linking Timepieces to the Blockchain

Each luxury watch in our collection is minted as a unique on-chain NFT, creating a strong link between the physical item and its digital counterpart. Metadata storage is divided into two systems:

* **Public Metadata on IPFS:** Public details like brand, model, and reference number are securely stored on the decentralized IPFS.
* **Private Data in Secured Database:** Sensitive information, such as serial numbers and private documents, are stored securely in our database, maintaining privacy and security.

## Marketplace Contracts Overview

The marketplace contracts facilitate user-friendly and efficient listing, buying, and making offers


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://colle-1.gitbook.io/colle-marketplace-contracts/1_overview.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
