DOCSEARCHbyAlgolia
Submit Docs

Unlock Protocol Documentation

website·Indexed 35 days ago

https://docs.unlock-protocol.com

A decentralized protocol for memberships. This documentation covers the core protocol's Ethereum smart contracts, the Locksmith API for extended functionality, and developer tools including the Paywall JavaScript library, subgraph endpoints, and the Unlock Dashboard.

Tokens
81.3K
Snippets
583
Records
757
Agent score
63%

What's inside Unlock Protocol

  1. Overview of Unlock Protocol

    Unlock is a protocol designed for creating onchain memberships and subscriptions using NFTs. It allows creators, brands, or projects to manage access to resources such as online content, live events, and certifications through smart contracts.

  2. Overview of the Unlock Protocol UP token

    The UP token is the native governance token of the Unlock Protocol, deployed on the Base blockchain. It is used for rewarding developers and creators, as well as for participating in protocol governance through voting on proposals. Holding UP tokens is optional; creators can deploy smart contracts and members can purchase memberships without using UP tokens.

  3. Overview of the Unlock Protocol UP token

    The UP token is the native governance token of the Unlock Protocol, issued on the Base blockchain. It has a fixed maximum supply of 1,000,000,000 tokens. The token is used for rewarding developers and creators, participating in protocol governance via voting on proposals, and as part of a buyback-and-burn mechanism funded by protocol fees on financial transactions.

  4. Overview of the Unlock Protocol Ecosystem

    As of January 2025, the Unlock ecosystem consists of the following core components:

    • Core Protocol: A set of smart contracts deployed on multiple networks that allow creators to deploy locks and consumers to unlock them.
    • unlock-js: A JavaScript library for developers to interact with the protocol contracts.
    • Paywall Application: An embeddable tool for websites to restrict access to members and facilitate key purchases.
    • Unlock App: A dashboard for creators to manage locks and members, and for consumers to manage their keychain. It supports email/password accounts and credit card purchases via Unlock Inc.
    • Unlock Protocol Tokens (UP): Governance tokens used for ecosystem ownership and incentives.
    • Unlock DAO: A governance system allowing UP token holders to submit and vote on proposals regarding the protocol and treasury.
    • Events App: A specialized tool for event organizers to mint paid or free tickets.

  5. Overview of Unlock Protocol

    Unlock is an open-source, collectively owned, and community-governed peer-to-peer protocol used to create time-based memberships. It replaces siloed membership systems with a decentralized standard, allowing developers and creators to implement memberships that are represented as non-fungible tokens (NFTs). The protocol aims to shift web monetization from an attention-based model (advertising) to a membership-based model.

  7. Overview of Unlock Protocol core smart contracts

    The Unlock Protocol is powered by two primary Ethereum smart contracts deployed across all supported networks: the Unlock contract and the PublicLock contracts. While other contracts exist for governance and tokens, only the Unlock and PublicLock contracts are required for the core protocol functionality.

  8. Overview of Locksmith hosted API services

    Locksmith is a hosted API service that provides auxiliary functionality not included in the core Unlock protocol. It is designed to be useful for building applications and onboarding users, though it can be replaced by 3rd party native implementations. Current capabilities include:

    • Storing metadata for locks, keys, and users
    • Automated NFT membership renewals
    • Fiat payment integration
    • Ticket management
    • Webhooks for key and lock creation
    • Email delivery and QR code generation

  9. Overview of Unlock Protocol core functions

    Unlock Protocol is a decentralized system for managing memberships via NFTs. It centers around three primary functions:

    1. Minting: Creating membership NFTs. Memberships can be purchased by users (one-time or recurring) or granted/airdropped by a lock manager. Once minted, memberships can be extended, cancelled, terminated, or destroyed. Both public metadata (e.g., artwork) and private metadata (e.g., member info) can be updated post-minting.
    2. Gating: Verifying membership status to control access to perks, benefits, or resources. The protocol provides functions to check if a membership is valid or expired. It also supports 'hooks' to delegate checks to third-party contracts (e.g., checking for arbitrary ERC-721, ERC-1155, or ERC-20 tokens).
    3. Earning: Adopters who implement the protocol can earn UP governance tokens to participate in the Unlock DAO. Lock managers can also optionally configure the protocol to collect fees on membership purchases.

  10. Overview of the Unlock Protocol

    Unlock is an open-source, peer-to-peer protocol used by developers, creators, and platforms to implement onchain memberships and subscriptions. It utilizes a suite of upgradable smart contracts to create memberships as NFTs, enabling time-based and potentially recurring access to content or services.

  11. Overview of Unlock Protocol Governance

    Unlock Protocol utilizes a Decentralized Autonomous Organization (DAO) to ensure the protocol can evolve and support new behaviors. Governance is managed through a combination of on-chain governance (via DAO contracts) and off-chain governance (via Snapshot). Voting rights within the DAO are represented by Unlock Protocol Governance Tokens, which can be earned by users of the protocol.