Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.patchwork.dev/llms.txt

Use this file to discover all available pages before exploring further.

​
Setup your development environment

1

Install Foundry

Foundry is a smart contract development toolchain. You can install it by following the instructions at Foundry’s installation guide.
2

Initialize Forge

In the root of a new empty project folder, run:
forge init
3

Install Patchwork Contracts Library

forge install runic-inc/patchwork
4

Install OpenZeppelin Contracts

forge install openzeppelin/openzeppelin-contracts
5

Configure Project Remappings

In project root, create the file remappings.txt
@openzeppelin/=lib/openzeppelin-contracts/
@patchwork/=lib/patchwork/src/
forge-std/=lib/forge-std/src/
lib/=lib/
6

Install PDK

Option 1 - Local project installation (recommended for npm/js projects)
npm i @patchworkdev/pdk
Option 2 - Global binary installation
npm i -g @patchworkdev/pdk