Irys Documentation

Welcome to the Irys documentation repository. These docs are built using Nextra.

What is Irys?

Irys is the first datachain that combines storage and execution, enabling Programmable Data and simplifying the building of fully decentralized applications.

Storage

Irys offers a streamlined approach to onchain data storage. With a single upfront fee, users can securely store data for either permanent or temporary periods. The protocol ensures fault-tolerance, high availability and data integrity through a global network of miners and cryptographic verification.

Notably, Irys allows smart contracts to interact directly with stored data, opening up new possibilities for builders to create innovative applications.

Execution

With Programmable Data, smart contracts can access the entirety of onchain data. This allows developers to break free from the limitations of traditional EVM environments, where state storage is expensive and execution models are rigid.

Programmable Data unleashes developer creativity and enables new use cases previously inaccessible due to high state storage costs. Developers can now build fully onchain applications, where the UI, state, and all data are stored onchain.

Installation

1. Clone the repository:

   git clone https://github.com/your-username/irys-docs-v2.git
   cd irys-docs

2. Install dependencies:

   Make sure you have Node.js and npm installed. Then, run:

   npm install

3. Run the development server:

   Start the local development server with:

   npm run dev

   Open http://localhost:3000 with your browser to see the result.

Submitting a Pull Request (PR)

We welcome contributions from the community! To submit a PR, follow these steps:

1. Fork the repository:

   Click the "Fork" button on the top right of the repository page.

2. Clone your fork:

   git clone https://github.com/your-username/irys-docs-v2.git
   cd irys-docs

3. Create a new branch:

   git checkout -b feature/your-feature-name

4. Make your changes:

   Implement your changes and commit them with a clear and concise message:

   git add .
   git commit -m "Add feature: your-feature-name"

5. Push to your fork:

   git push origin feature/your-feature-name

6. Create a Pull Request:

   Go to the original repository and click on the "New Pull Request" button. Select your fork and branch as the source, and the main branch of the original repository as the target. Provide a clear description of your changes and submit the PR.

License

This project is licensed under the MIT License.