Skip to content

runic-inc/pdk

Repository files navigation

Patchwork Development Kit

Setup

To set up your development environment, follow these steps:

  1. Install Foundry: Foundry is a smart contract development toolchain. You can install it by following the instructions at Foundry's installation guide.

    forge install
  2. Install Node.js dependencies:

    npm install

Testing Your Environment

To ensure your environment is set up correctly, you can run the following tests:

  • Using npm:

    npm test
  • Using Foundry:

    forge test

Using the PDK

To use the Patchwork Development Kit (PDK), run:

npx pdk

Development

For development tasks such as building the TypeScript project and linking the executable, follow these steps:

  1. Build TypeScript to JavaScript:

    npm run build
  2. Link the Executable:

    npm link
  3. Using the PDK: After linking, you can use the pdk command to access the Patchwork Development Kit:

    pdk