getScopeName

Functions

GitHub

Patchwork Wizard

Join our Discord

Patchwork Docs

Patchwork Protocol

Patchwork Development Kit

Contracts Reference

Example Projects

Patchwork Home

Core interface for IPatchwork721 and contracts supporting Scopes

IPatchworkScoped

Patchwork is an Ethereum protocol and set of standards designed to supercharge onchain entities new & old with fully onchain data.

Introduction

A 10 minute primer to help you understand how Patchwork works at a high level

Patchwork 101

Quickstart

Build and launch a simple Patchwork app on Sepolia in less than 5 minutes.

Deploying your first app

Scopes are application-level Patchwork namespaces for configuring settings and permissions or your app.

Scopes

Learn how to create your Patchwork metadata schemas

Data modeling

Learn the intricacies of Fragment relationships

Fragment assignments

Patching

Understand the freezing & locking mechanics that ensure metadata integrity

Freezing & locking

Events

Learn how fee accrual and accounting works for Scopes

Handling fees

Deep dive the Patchwork metadata standard

Metadata Standard

Running list of current Patchwork Protocol deployments

Networks

Protocol changelog

Contracts changelog

We're committed to openly and continually auditing our protocol & core contracts for security flaws and publicizing their findings.

Audit history

The Patchwork Development Kit makes working with Patchwork a breeze. With just a few commands you can quickly scaffold a new project, generate solidity contracts, generate frontend and backend code to interact with those contracts, and spin up a functional Docker container to start testing everything end-to-end.

Overview

create-patchwork is the fastest way to build a full-stack Patchwork application, generating everything you need for a deployable onchain app in minutes.

Getting started

Project configuration

Local development

Basic Patchwork721

Complex metadata with arrays

Single-assignable Fragment

Multi-assignable Fragment

Fixed-length references

Dynamic references

Patch for ERC721 targets

Patch for ERC1155 targets

Patch for account targets

Patch + Fragment

Patch + Assignee

Interface for interacting with Patchwork Protocol

IPatchworkProtocol

Interface for contracts supporting Patchwork metadata standard.

IPatchwork721

Metadata for IPatchwork721 and related contract interfaces

IPatchworkMetadata

IPatchwork721 interface to add protocol-level mint support and enable mint fee accrual to the contract’s Scope.

IPatchworkMintable

IPatchwork721 extension for contracts supporting Patchwork assignment

IPatchworkAssignable

IPatchworkSingleAssignable

IPatchworkMultiAssignable

IPatchwork721 extension to enable Lite Reference support, allowing them to accommodate Fragment assignments.

Protocol API

Core Interfaces

Fragment extensions

Assignee extensions

Patch extensions

Utils

IPatchworkScoped

Functions

getScopeName

Protocol API

Core Interfaces

Fragment extensions

Assignee extensions

Patch extensions

Utils

​Functions

​getScopeName

Functions

getScopeName