The Irys Provenance Toolkit is a collection of UI components you can use to kickstart your next application. It contains UI components for managing node balances, uploading files, performing gassless uploads, and querying transactions.
The toolkit is fully open source, you are welcome to use it any way you want with or without attribution.
For details on how to use (and customize) each component, refer to our docs.
You can interact with the provenance toolkit at https://provenance-toolkit.irys.xyz
The Provenance Toolkit is designed for intermediate to advanced developers and assumes you have a working knowledge of NextJS, TypeScript, and Tailwind. Beginning developers may want to start with our tutorials and quests which are designed for a broader audience.
- Fork or clone https://github.com/Irys-xyz/provenance-toolkit
- Run
npm installoryarnfrom within the project directory - Rename
.env.local.exampleto.env.localand follow the configuration instructions in that file - Run
npm run startfrom within the project directory - Launch the Provenance Toolkit at http://localhost:3000/
The project is broken into three main categories:
- Components: The UI components. These can be added to your project and used as is.
- Navigation routes: NextJS navigation routing. If you’re building your own project on top of the Provenance Toolkit, you can delete these routes and create your own.
- Utils: Utility functions used by the UI components.
These are further detailed in our docs.
Included within the Provenance Toolkit are the following components:
Manage node balances.
Upload single files or groups of files.
Upload large files, and provide feedback with a progress bar.
Upload files and attach a UDL.
Pay for user uploads server-side.
Query Irys transactions.
