Skip to main content

SDK Overview

The @policy-kit/sdk package is the primary interface for building, deploying, and managing policies. It provides a collection of clients and utilities that work together.

Package Exports

Components

PolicyBuilder

Fluent API for constructing policies with compile-time validation.

PolicyKit Client

High-level client that orchestrates deployment and management.

Policy Simulator

Local evaluation engine for testing policies without deploying.

IPFS Client

Pin and retrieve policy documents from IPFS.

Lit Client

Integration with Lit Protocol for off-chain rule evaluation.

Quick Reference

Building a Policy

Deploying a Policy

Simulating a Transaction

Dependencies