
In the Unlock Protocol, every time a key is purchased for any lock, a small transaction is sent back to the core Unlock factory contract to keep track of all existing sales on the network. For each network (Ethereum mainnet, Polygon, etc.), we calculate what we call a Gross Network Product (GNP) that consolidates the value of all sales into a single amount of native currency (ETH for mainnet, MATIC for Polygon, etc). The GNP is a useful indicator to track the evolution of the protocol’s activity across chains.

Unlock has upgraded its price oracle to Uniswap v3 to increase accuracy and coverage when calculating the total value of sales on each network.

## The Oracle Problem

Locks across networks can be priced in a variety of ERC20-compatible tokens. Therefore, we need to convert the amount of ERC20 tokens to native currency before adding it to the GNP. In blockchain ecosystems, the system that allows you to retrieve information from a 3rd party service (such as retrieving the price of a token) is called an [oracle](https://ethereum.org/en/developers/docs/oracles/).

The main issue with smart contracts is that they can’t interact properly outside of the chain, and therefore require “oracles” to tell them what is happening outside, in the off-chain world. The famous [oracle problem](https://chain.link/education/blockchain-oracles) states that contracts on one hand can’t access data outside of the chain, but on the other hand shouldn’t rely to a single source of trust to provide data as this nullify the advantages of a decentralised security model. To mitigate this inherent risk, models of decentralised oracles have been developed.

## Using Uniswap v3’s Decentralized Oracle

Uniswap is one of the most famous decentralised exchanges operating on EVM chains. The new version (Uniswap v3) provides a neat way to query exchange data through an oracle in the form of a [simple contract](https://docs.uniswap.org/protocol/concepts/V3-overview/oracle). To date, the Unlock Protocol has been using the prior version of the Uniswap Oracle (v2), which required us to maintain a dedicated oracle. As of today, the Unlock Protocol will be upgraded to use the latest Uniswap v3, providing a more reliable and comprehensive coverage of various token prices. In this new implementation, GNP calculations will be simplified and cover a wider variety of possible tokens.

You can see the details of the changes in [this pull request](https://github.com/unlock-protocol/unlock/pull/10030), as well as use the oracle for your own needs by querying directly the deployed contract on each network.

Here are the addresses of contracts deployed on the [various networks](https://docs.uniswap.org/protocol/reference/deployments) where Uniswap is supported:

- mainnet: [`0x951A807b523cF6e178e0ab80fBd2C9B035521931`](https://etherscan.io/address/0x951A807b523cF6e178e0ab80fBd2C9B035521931)
- polygon : [`0xE77c7F14e8EB9925ca418bF80c0a81a5B9C87683`](https://polygonscan.com/address/0xE77c7F14e8EB9925ca418bF80c0a81a5B9C87683)
- arbitrum : [`0x821d830a7b9902F83359Bf3Ac727B04b10FD461d`](https://arbiscan.io/address/0x821d830a7b9902F83359Bf3Ac727B04b10FD461d)
- optimism : [`0x1FF7e338d5E582138C46044dc238543Ce555C963`](https://optimistic.etherscan.io/address/0x1FF7e338d5E582138C46044dc238543Ce555C963#code)
- celo : [`0x5108412Dd50A6ea79d2F13D5d1A23FDD9bF532db`](https://celoscan.io/address/0x5108412Dd50A6ea79d2F13D5d1A23FDD9bF532db#code)
- mumbai : [`0x5108412Dd50A6ea79d2F13D5d1A23FDD9bF532db`](https://mumbai.polygonscan.com/address/0x5108412Dd50A6ea79d2F13D5d1A23FDD9bF532db#code)
- goerli : [`0x25197CaCDE16500032EF4B35d60c6f7aEd4a38a5`](https://goerli.etherscan.io/address/0x25197CaCDE16500032EF4B35d60c6f7aEd4a38a5)


Unlock upgrades its price oracle to Uniswap v3 to increase accuracy and coverage when calculating the total value of sales on each network.

Unlock upgrades Uniswap Oracle to v3 for more accurate calculations of Unlock Gross Network Product

Using the Uniswap v3 Oracle in the Unlock Contract

<p>In the Unlock Protocol, every time a key is purchased for any lock, a small transaction is sent back to the core Unlock factory contract to keep track of all existing sales on the network. For each network (Ethereum mainnet, Polygon, etc.), we calculate what we call a Gross Network Product (GNP) that consolidates the value of all sales into a single amount of native currency (ETH for mainnet, MATIC for Polygon, etc). The GNP is a useful indicator to track the evolution of the protocol’s activity across chains.</p>
<p>Unlock has upgraded its price oracle to Uniswap v3 to increase accuracy and coverage when calculating the total value of sales on each network.</p>
<h2>The Oracle Problem</h2>
<p>Locks across networks can be priced in a variety of ERC20-compatible tokens. Therefore, we need to convert the amount of ERC20 tokens to native currency before adding it to the GNP. In blockchain ecosystems, the system that allows you to retrieve information from a 3rd party service (such as retrieving the price of a token) is called an <a href="https://ethereum.org/en/developers/docs/oracles/">oracle</a>.</p>
<p>The main issue with smart contracts is that they can’t interact properly outside of the chain, and therefore require “oracles” to tell them what is happening outside, in the off-chain world. The famous <a href="https://chain.link/education/blockchain-oracles">oracle problem</a> states that contracts on one hand can’t access data outside of the chain, but on the other hand shouldn’t rely to a single source of trust to provide data as this nullify the advantages of a decentralised security model. To mitigate this inherent risk, models of decentralised oracles have been developed.</p>
<h2>Using Uniswap v3’s Decentralized Oracle</h2>
<p>Uniswap is one of the most famous decentralised exchanges operating on EVM chains. The new version (Uniswap v3) provides a neat way to query exchange data through an oracle in the form of a <a href="https://docs.uniswap.org/protocol/concepts/V3-overview/oracle">simple contract</a>. To date, the Unlock Protocol has been using the prior version of the Uniswap Oracle (v2), which required us to maintain a dedicated oracle. As of today, the Unlock Protocol will be upgraded to use the latest Uniswap v3, providing a more reliable and comprehensive coverage of various token prices. In this new implementation, GNP calculations will be simplified and cover a wider variety of possible tokens.</p>
<p>You can see the details of the changes in <a href="https://github.com/unlock-protocol/unlock/pull/10030">this pull request</a>, as well as use the oracle for your own needs by querying directly the deployed contract on each network.</p>
<p>Here are the addresses of contracts deployed on the <a href="https://docs.uniswap.org/protocol/reference/deployments">various networks</a> where Uniswap is supported:</p>
<ul>
<li>mainnet: <a href="https://etherscan.io/address/0x951A807b523cF6e178e0ab80fBd2C9B035521931"><code>0x951A807b523cF6e178e0ab80fBd2C9B035521931</code></a></li>
<li>polygon : <a href="https://polygonscan.com/address/0xE77c7F14e8EB9925ca418bF80c0a81a5B9C87683"><code>0xE77c7F14e8EB9925ca418bF80c0a81a5B9C87683</code></a></li>
<li>arbitrum : <a href="https://arbiscan.io/address/0x821d830a7b9902F83359Bf3Ac727B04b10FD461d"><code>0x821d830a7b9902F83359Bf3Ac727B04b10FD461d</code></a></li>
<li>optimism : <a href="https://optimistic.etherscan.io/address/0x1FF7e338d5E582138C46044dc238543Ce555C963#code"><code>0x1FF7e338d5E582138C46044dc238543Ce555C963</code></a></li>
<li>celo : <a href="https://celoscan.io/address/0x5108412Dd50A6ea79d2F13D5d1A23FDD9bF532db#code"><code>0x5108412Dd50A6ea79d2F13D5d1A23FDD9bF532db</code></a></li>
<li>mumbai : <a href="https://mumbai.polygonscan.com/address/0x5108412Dd50A6ea79d2F13D5d1A23FDD9bF532db#code"><code>0x5108412Dd50A6ea79d2F13D5d1A23FDD9bF532db</code></a></li>
<li>goerli : <a href="https://goerli.etherscan.io/address/0x25197CaCDE16500032EF4B35d60c6f7aEd4a38a5"><code>0x25197CaCDE16500032EF4B35d60c6f7aEd4a38a5</code></a></li>
</ul>



![metadata configurator video](/images/blog/metadata-configurator/main.gif)

Most creators want to customize the attributes and add features to their NFTs. These features show up on NFT marketplaces such as OpenSea. Until now, they had to customize and manage the metadata on their own and update it on their own. It required coding and dealing with scripts. It wasn’t user friendly and added friction to working with Unlock.

To simplify this process, we are launching a no-code metadata configurator. With it, creators can add attributes such as properties, levels, stats, and other metadata to their NFT right from the Unlock Dashboard. This new feature also provides custom presets for ticketing and adding creator content such as YouTube videos, website, and animations.

## How to start

On the lock management page, you can open the metadata configurator by clicking on the `Edit NFT Properties` button. This will only be visible for lock manager.

![lock manage page](/images/blog/metadata-configurator/lock-page.png)

The configurator is split into multiple sections. Each section is collapsible from the UI.

### Basic details

The basic details section contains fields such as name, description, and the external URL for your NFT memberships.

![Basics](/images/blog/metadata-configurator/basic.png)

### Event ticketing

The event ticketing section allows event organizers to set up custom data for their tickets. Any ticket metadata changed here will show up as attributes on OpenSea and other marketplaces. This ticket data is also used by Unlock to generate a QR code ticket for NFTs and power the verification experience.

![Ticket](/images/blog/metadata-configurator/ticket.png)

#### Preview

As you are making edits, you can click on the Preview Ticket button to see what your ticket would actually look like. All fields are updated in real-time to reflect changes.

![Preview Ticket](/images/blog/metadata-configurator/preview-ticket.png)

### Advanced

Creators with a YouTube channel or a blog can use this section to display their videos and blog posts in the main preview box on OpenSea and other marketplaces. A user will be able to go to OpenSea and watch the video directly on your NFT page.

![Advanced](/images/blog/metadata-configurator/advanced.png)

### Custom Properties

You can add custom properties, levels, and stats to your NFT to truly highlight the unique characteristics of your NFTs.

Please note that each item will be displayed slightly differently on OpenSea and other marketplaces. We provide a preview of how they will be displayed but it is not a 1-1 representation.

![Custom](/images/blog/metadata-configurator/custom.png)

#### Add Properties

You can open the Add Property modal using the Add button inside the property section. On Add Property modal, you can add or remove existing properties. Each property has a trait type and value.

![Add Properties](/images/blog/metadata-configurator/add-stats.png)

#### Add Levels

Each level has a trait type, value, and max value. The value and max value are used to display a progress indicator on OpenSea and other marketplaces.

![Add Levels](/images/blog/metadata-configurator/add-levels.png)

#### Add Stats

Stats are the same as levels, but won't be displayed as a progress indicator on OpenSea and other marketplaces.

![Add Stats](/images/blog/metadata-configurator/add-stats.png)

The Unlock team is excited to bring you more no-code tools to manage your NFT memberships. We are dedicated to improving the user experience to onboard more non-technical users.

## What if I find an issue or bug in the metadata configurator?

Please open an issue on Github or tell us in Discord and we’ll fix it as soon as possible.


Configure metadata for your NFT memberships, passes, tickets, and more from the Unlock Dashboard without programming.

A Brand New Metadata Configurator

<p><img src="/images/blog/metadata-configurator/main.gif" alt="metadata configurator video"></p>
<p>Most creators want to customize the attributes and add features to their NFTs. These features show up on NFT marketplaces such as OpenSea. Until now, they had to customize and manage the metadata on their own and update it on their own. It required coding and dealing with scripts. It wasn’t user friendly and added friction to working with Unlock.</p>
<p>To simplify this process, we are launching a no-code metadata configurator. With it, creators can add attributes such as properties, levels, stats, and other metadata to their NFT right from the Unlock Dashboard. This new feature also provides custom presets for ticketing and adding creator content such as YouTube videos, website, and animations.</p>
<h2>How to start</h2>
<p>On the lock management page, you can open the metadata configurator by clicking on the <code>Edit NFT Properties</code> button. This will only be visible for lock manager.</p>
<p><img src="/images/blog/metadata-configurator/lock-page.png" alt="lock manage page"></p>
<p>The configurator is split into multiple sections. Each section is collapsible from the UI.</p>
<h3>Basic details</h3>
<p>The basic details section contains fields such as name, description, and the external URL for your NFT memberships.</p>
<p><img src="/images/blog/metadata-configurator/basic.png" alt="Basics"></p>
<h3>Event ticketing</h3>
<p>The event ticketing section allows event organizers to set up custom data for their tickets. Any ticket metadata changed here will show up as attributes on OpenSea and other marketplaces. This ticket data is also used by Unlock to generate a QR code ticket for NFTs and power the verification experience.</p>
<p><img src="/images/blog/metadata-configurator/ticket.png" alt="Ticket"></p>
<h4>Preview</h4>
<p>As you are making edits, you can click on the Preview Ticket button to see what your ticket would actually look like. All fields are updated in real-time to reflect changes.</p>
<p><img src="/images/blog/metadata-configurator/preview-ticket.png" alt="Preview Ticket"></p>
<h3>Advanced</h3>
<p>Creators with a YouTube channel or a blog can use this section to display their videos and blog posts in the main preview box on OpenSea and other marketplaces. A user will be able to go to OpenSea and watch the video directly on your NFT page.</p>
<p><img src="/images/blog/metadata-configurator/advanced.png" alt="Advanced"></p>
<h3>Custom Properties</h3>
<p>You can add custom properties, levels, and stats to your NFT to truly highlight the unique characteristics of your NFTs.</p>
<p>Please note that each item will be displayed slightly differently on OpenSea and other marketplaces. We provide a preview of how they will be displayed but it is not a 1-1 representation.</p>
<p><img src="/images/blog/metadata-configurator/custom.png" alt="Custom"></p>
<h4>Add Properties</h4>
<p>You can open the Add Property modal using the Add button inside the property section. On Add Property modal, you can add or remove existing properties. Each property has a trait type and value.</p>
<p><img src="/images/blog/metadata-configurator/add-stats.png" alt="Add Properties"></p>
<h4>Add Levels</h4>
<p>Each level has a trait type, value, and max value. The value and max value are used to display a progress indicator on OpenSea and other marketplaces.</p>
<p><img src="/images/blog/metadata-configurator/add-levels.png" alt="Add Levels"></p>
<h4>Add Stats</h4>
<p>Stats are the same as levels, but won't be displayed as a progress indicator on OpenSea and other marketplaces.</p>
<p><img src="/images/blog/metadata-configurator/add-stats.png" alt="Add Stats"></p>
<p>The Unlock team is excited to bring you more no-code tools to manage your NFT memberships. We are dedicated to improving the user experience to onboard more non-technical users.</p>
<h2>What if I find an issue or bug in the metadata configurator?</h2>
<p>Please open an issue on Github or tell us in Discord and we’ll fix it as soon as possible.</p>



The original Unlock Protocol UDT Grants program was launched in 2021 with a goal to decentralize governance of Unlock Protocol, expand the number of [integrations](https://unlock-protocol.com/guides/category/plugins/) across the Unlock ecosystem, and increase the number of applications built with Unlock.

We’ve taken the learnings from this last year, along with our mission to continue to decentralize at scale, and made significant improvements to the grants program, which we hope will mean the next year is an even bigger success! Here’s what’s new.

### Streamlining the grant process and adding new capabilities

For the revamped grants program, we’ve partnered with [Wonderverse](https://app.wonderverse.xyz/organization/unlock/boards?entity=task), a DAO tool for collaboration and organization. Adding a decentralized tool opened up the opportunity to improve workflow and communication across the Unlock grants process. Let’s take a look how!

When a prospective grantee submits their grant application, the Unlock grants committee reviews their submission. We’ve streamlined the grant review process and implemented it via Wonderverse. This should reduce the time it takes from application to committee decision, with a target of returning a decision to the grant applicant within two weeks of their submission.

For grant applications that have been accepted and their milestones have been met, we now have the ability to make UDT grant awards directly from this same integrated system. This means we’ll also be able to speed up the time it takes to distribute grant rewards, getting UDT into the hands of grantees sooner!

I’m also excited to say that it means we now have the capability and capacity to create individual grantee workspaces where we can more closely communicate, educate and support our grantees. The goal is less friction for grantees to get what they need to be successful. This should lead to shorter launch timelines and higher-quality end products.

### Improved guides & handbooks

We’ve updated all of our guides and handbooks for grantees and published them in our
[docs](https://docs.unlock-protocol.com/governance/grants-bounties/). This should improve the understanding of how the grants program works for those interested in
[applying](https://docs.unlock-protocol.com/governance/grants-bounties/udt-grantee-handbook#submitting-an-application).

In addition, our new processes should make adding new [grant committee](https://docs.unlock-protocol.com/governance/grants-bounties/grant-committee-applicant-guide)
members much easier. This will enable Unlock to scale the program as the ecosystem grows.

Using the experience gained from the over 100 grant applications we received to date, we sought to increase the impact of the projects we give grants to and have made improvements to the
[grant review](https://docs.unlock-protocol.com/governance/grants-bounties/grant-review-guide) guidance for the committee.

### What’s next?

We’re thrilled so far with all of these improvements and we’re confident this next season of grants will be even more effective at increasing network volume and adding to the credibility and visibility of Unlock Protocol. On a quarterly basis, the grants committee will review the progress of the program and make proposals to the community for iterative improvements, if needed. This will accelerate the success of the program while maintaining our commitment to decentralization.

👉 Interested in building with us? Fill out an [application](https://docs.unlock-protocol.com/governance/grants-bounties/udt-grantee-handbook#submitting-an-application) for one of grants now!

### Looking back at the last year: Unlock Protocol grant success stories

Over the past year, the grants program has had success spawning work in areas of plugins and integrations, education, showcases, events, and platform subscriptions. Some of the highlights include:

**Integrations & Plugins**

- [Guild.xyz](https://unlock-protocol.com/guides/guild-xyz/)
- [Unity Game Engine](https://github.com/thehen/unlock-unity-package)
- [Monetized](https://unlock-protocol.com/guides/how-to-token-gate-notion/) (Notion)
- [Collab.Land](https://unlock-protocol.com/guides/discord-with-collab-land/)
- [Decentraland](https://unlock-protocol.com/blog/decentraland)
- [Firebase](https://unlock-protocol.com/blog/firebase-integration)
- [Discourse](https://unlock-protocol.com/blog/discourse-plugin)
- [Drupal](https://www.drupal.org/project/unlock)

**Built with Unlock**

- [Tales of Elatora](https://unlock-protocol.com/blog/talesofelatora)
- [Content Rooms](https://contentrooms.com/)
- [Bonsai.so](https://bonsai.so/)
- [Dinner DAO](https://unlock-protocol.com/blog/dinnerdao)
- [Unfurl](https://unlock-protocol.com/blog/unfurl-connect)

**Events**

- [ETHAnglia](https://ethanglia.org/)

**Education**

- [Web3Academy](https://w3academy.io/)
- [dProgramming University](https://dprogramminguniversity.com/courses/unlock-protocol-101/)
- [Unlock Showcase](https://www.unlockshowcase.com/)

With the upgraded grants program, we can’t wait to see what the community creates next! You can fill out a grant application here!


Improvements go live to streamline processes and accelerate growth for the Unlock ecosystem.

Improvements go live to streamline processes and accelerate growth for the Unlock ecosystem

Unlock Announces Grants Program Upgrade

<p>The original Unlock Protocol UDT Grants program was launched in 2021 with a goal to decentralize governance of Unlock Protocol, expand the number of <a href="https://unlock-protocol.com/guides/category/plugins/">integrations</a> across the Unlock ecosystem, and increase the number of applications built with Unlock.</p>
<p>We’ve taken the learnings from this last year, along with our mission to continue to decentralize at scale, and made significant improvements to the grants program, which we hope will mean the next year is an even bigger success! Here’s what’s new.</p>
<h3>Streamlining the grant process and adding new capabilities</h3>
<p>For the revamped grants program, we’ve partnered with <a href="https://app.wonderverse.xyz/organization/unlock/boards?entity=task">Wonderverse</a>, a DAO tool for collaboration and organization. Adding a decentralized tool opened up the opportunity to improve workflow and communication across the Unlock grants process. Let’s take a look how!</p>
<p>When a prospective grantee submits their grant application, the Unlock grants committee reviews their submission. We’ve streamlined the grant review process and implemented it via Wonderverse. This should reduce the time it takes from application to committee decision, with a target of returning a decision to the grant applicant within two weeks of their submission.</p>
<p>For grant applications that have been accepted and their milestones have been met, we now have the ability to make UDT grant awards directly from this same integrated system. This means we’ll also be able to speed up the time it takes to distribute grant rewards, getting UDT into the hands of grantees sooner!</p>
<p>I’m also excited to say that it means we now have the capability and capacity to create individual grantee workspaces where we can more closely communicate, educate and support our grantees. The goal is less friction for grantees to get what they need to be successful. This should lead to shorter launch timelines and higher-quality end products.</p>
<h3>Improved guides &#x26; handbooks</h3>
<p>We’ve updated all of our guides and handbooks for grantees and published them in our
<a href="https://docs.unlock-protocol.com/governance/grants-bounties/">docs</a>. This should improve the understanding of how the grants program works for those interested in
<a href="https://docs.unlock-protocol.com/governance/grants-bounties/udt-grantee-handbook#submitting-an-application">applying</a>.</p>
<p>In addition, our new processes should make adding new <a href="https://docs.unlock-protocol.com/governance/grants-bounties/grant-committee-applicant-guide">grant committee</a>
members much easier. This will enable Unlock to scale the program as the ecosystem grows.</p>
<p>Using the experience gained from the over 100 grant applications we received to date, we sought to increase the impact of the projects we give grants to and have made improvements to the
<a href="https://docs.unlock-protocol.com/governance/grants-bounties/grant-review-guide">grant review</a> guidance for the committee.</p>
<h3>What’s next?</h3>
<p>We’re thrilled so far with all of these improvements and we’re confident this next season of grants will be even more effective at increasing network volume and adding to the credibility and visibility of Unlock Protocol. On a quarterly basis, the grants committee will review the progress of the program and make proposals to the community for iterative improvements, if needed. This will accelerate the success of the program while maintaining our commitment to decentralization.</p>
<p>👉 Interested in building with us? Fill out an <a href="https://docs.unlock-protocol.com/governance/grants-bounties/udt-grantee-handbook#submitting-an-application">application</a> for one of grants now!</p>
<h3>Looking back at the last year: Unlock Protocol grant success stories</h3>
<p>Over the past year, the grants program has had success spawning work in areas of plugins and integrations, education, showcases, events, and platform subscriptions. Some of the highlights include:</p>
<p><strong>Integrations &#x26; Plugins</strong></p>
<ul>
<li><a href="https://unlock-protocol.com/guides/guild-xyz/">Guild.xyz</a></li>
<li><a href="https://github.com/thehen/unlock-unity-package">Unity Game Engine</a></li>
<li><a href="https://unlock-protocol.com/guides/how-to-token-gate-notion/">Monetized</a> (Notion)</li>
<li><a href="https://unlock-protocol.com/guides/discord-with-collab-land/">Collab.Land</a></li>
<li><a href="https://unlock-protocol.com/blog/decentraland">Decentraland</a></li>
<li><a href="https://unlock-protocol.com/blog/firebase-integration">Firebase</a></li>
<li><a href="https://unlock-protocol.com/blog/discourse-plugin">Discourse</a></li>
<li><a href="https://www.drupal.org/project/unlock">Drupal</a></li>
</ul>
<p><strong>Built with Unlock</strong></p>
<ul>
<li><a href="https://unlock-protocol.com/blog/talesofelatora">Tales of Elatora</a></li>
<li><a href="https://contentrooms.com/">Content Rooms</a></li>
<li><a href="https://bonsai.so/">Bonsai.so</a></li>
<li><a href="https://unlock-protocol.com/blog/dinnerdao">Dinner DAO</a></li>
<li><a href="https://unlock-protocol.com/blog/unfurl-connect">Unfurl</a></li>
</ul>
<p><strong>Events</strong></p>
<ul>
<li><a href="https://ethanglia.org/">ETHAnglia</a></li>
</ul>
<p><strong>Education</strong></p>
<ul>
<li><a href="https://w3academy.io/">Web3Academy</a></li>
<li><a href="https://dprogramminguniversity.com/courses/unlock-protocol-101/">dProgramming University</a></li>
<li><a href="https://www.unlockshowcase.com/">Unlock Showcase</a></li>
</ul>
<p>With the upgraded grants program, we can’t wait to see what the community creates next! You can fill out a grant application here!</p>



Creating a compelling checkout flow for online purchases is a thorny problem. Every creator who is offering memberships, ticketing, or other experiences to their community has a wide variety of options to consider on exactly what required information may be needed from each purchaser. When you add the new experiences of web3 into the mix, checkout flows for creating or minting can get very sophisticated, very quickly, and can be very difficult to configure.

To help improve the experience of creators who are building checkout experiences in web3, Unlock has developed a Checkout Builder that provides a no-code way to build and customize a checkout experience.

The Checkout Builder greatly speeds and simplifies the process of creating checkout flows by applying no-code principles to a process that until now required technical configuration to develop checkout flows.

Let's go through step-by-step and look at the new capabilities Locksmiths have available to them to build checkout experiences for minting membership NFTs.

## Checkout Builder overview

You can access the Checkout Builder page from your lock page by clicking the "Generate URL” button, or by going directly to this URL: [https://app.unlock-protocol.com/locks/checkout-url](https://app.unlock-protocol.com/locks/checkout-url).

![Checkout Builder Link](/images/blog/checkout-builder-release/checkout-overview-1.png)

On the Checkout Builder page, we can see on the left side the preview of what your checkout experience will look like. On the right side of the page there is a form with the information you can edit to configure the experience.

![Checkout Page Link](/images/blog/checkout-builder-release/checkout-overview-2.png)

Edits made on the right side of the page will automatically update the preview on the left and give you a real-time overview of the final result.

For every field, there is also a description that provides more context about the related field.

The form to customize the checkout has 2 sections, each on its own tab:

- `Configuration`: Where we can find general configuration and setup
- `Locks`: Where we can add locks and customize them in more detail

Let’s create a customized checkout experience and generate a checkout URL that we can share!

## Headers and additional behavior

In the `Configuration` tab, we can set all the basic details about the lock. In the following example, we set the title to `Demo x Panda` and we can see it reflect on the preview. We can also set a custom icon.

In order to generate a checkout URL, we need to add one or more locks. To do this, we can switch to the `Locks` tab.

![Header Checkout](/images/blog/checkout-builder-release/header-checkout.gif)

## Add locks

To add locks, the first thing we need to do is select a `Network` and the `Lock` we want to add.

The `Lock` dropdown will automatically show the list of our locks for every network.

![Add Lock Header](/images/blog/checkout-builder-release/add-lock.png)

![Add Lock Selection](/images/blog/checkout-builder-release/add-lock-1.png)

When the lock is selected, we can see it displayed in real-time on the preview.

![Lock List](/images/blog/checkout-builder-release/lock-list.png)

As described in the previous step, we can follow the same process in order to add additional locks to our checkout page, if needed.

### Detailed membership configuration

Our membership may have a number of traits that we’ll want to represent in the smart contract. Let’s take scenario:

_"We need a Lock that sets our membership to renew 2 times, sets a maximum number of five memberships an individual user can purchase in a single wallet, and requires an email address so we can communicate with the member via email.”_

The above items are configured in the `Settings` section of the Checkout Builder:

![Lock List](/images/blog/checkout-builder-release/settings.png)

And finally, when the lock is added with the `Settings`, we can see `second lock demo` now contains all the details we added.

![Lock Settings](/images/blog/checkout-builder-release/locks-list-multiple.png)

## Removing a lock from the checkout

A lock can be removed from the checkout experience by clicking the cross icon on the lock list.

![Remove Lock Overview](/images/blog/checkout-builder-release/remove-lock.png)

![Remove Lock GIF](/images/blog/checkout-builder-release/remove-lock-animation.gif)

## Collecting metadata

When setting up a membership experience, there is often information about your members (”metadata”) that is required to communicate with them (e.g. address), reward them (e.g. t-shirt size), and otherwise have a richer understanding of who a member is.

When collecting metadata during the checkout flow, you can set metadata items to collect at checkout time by clicking `Add metadata` in the Checkout Builder.

When `Add metadata` is enabled, a form where you can add detail for the metadata will be displayed. For each item of metadata, a number of fields are required.

- `name`: the name of the field that's shown as a label
- `default value`: default value of the field
- `type`: type of the field
- `required`: specify if the field is required when true
- `placeholder`: the placeholder that's shown in the input type
- `public`: if this item of metadata should be visible to everyone

### Add metadata

![Add Metadata](/images/blog/checkout-builder-release/metadata.png)

### Metadata on preview

![Metadata Preview](/images/blog/checkout-builder-release/metadata-preview.png)

## Copy and share!

That's all! You have now configured a checkout flow that can be shared with your prospective members. You can now copy the generated URL and share it to your community on your website, via social media, through email, or by any other method you like.

![Checkout Builder Demo Animation](/images/blog/checkout-builder-release/copy-link-builder.gif)

## One more thing: Developers can download the JSON configuration for a checkout

While the above steps are especially helpful for creators who are creating memberships for their community, the Checkout Builder can be a huge time-saver for developers as well. If you are developing on top of Unlock Protocol and need to integrate a checkout configuration into your custom code, you can configure the checkout experience using the Checkout Builder and then download a fully-configured JSON file to [configure the Paywall](https://docs.unlock-protocol.com/tools/paywall/locking-page/#configure-the-paywall) in your application.

![Download JSON](/images/blog/checkout-builder-release//download-json.png)

**What if I find an issue or bug in the new checkout builder?**

Please open an issue on Github or tell us in Discord and we'll fix it ASAP.


Unlock launches a checkout builder to easily customize your checkout experience — no programming expertise needed.

Unlock Unveils No-Code Membership NFT Checkout Builder

<p>Creating a compelling checkout flow for online purchases is a thorny problem. Every creator who is offering memberships, ticketing, or other experiences to their community has a wide variety of options to consider on exactly what required information may be needed from each purchaser. When you add the new experiences of web3 into the mix, checkout flows for creating or minting can get very sophisticated, very quickly, and can be very difficult to configure.</p>
<p>To help improve the experience of creators who are building checkout experiences in web3, Unlock has developed a Checkout Builder that provides a no-code way to build and customize a checkout experience.</p>
<p>The Checkout Builder greatly speeds and simplifies the process of creating checkout flows by applying no-code principles to a process that until now required technical configuration to develop checkout flows.</p>
<p>Let's go through step-by-step and look at the new capabilities Locksmiths have available to them to build checkout experiences for minting membership NFTs.</p>
<h2>Checkout Builder overview</h2>
<p>You can access the Checkout Builder page from your lock page by clicking the "Generate URL” button, or by going directly to this URL: <a href="https://app.unlock-protocol.com/locks/checkout-url">https://app.unlock-protocol.com/locks/checkout-url</a>.</p>
<p><img src="/images/blog/checkout-builder-release/checkout-overview-1.png" alt="Checkout Builder Link"></p>
<p>On the Checkout Builder page, we can see on the left side the preview of what your checkout experience will look like. On the right side of the page there is a form with the information you can edit to configure the experience.</p>
<p><img src="/images/blog/checkout-builder-release/checkout-overview-2.png" alt="Checkout Page Link"></p>
<p>Edits made on the right side of the page will automatically update the preview on the left and give you a real-time overview of the final result.</p>
<p>For every field, there is also a description that provides more context about the related field.</p>
<p>The form to customize the checkout has 2 sections, each on its own tab:</p>
<ul>
<li><code>Configuration</code>: Where we can find general configuration and setup</li>
<li><code>Locks</code>: Where we can add locks and customize them in more detail</li>
</ul>
<p>Let’s create a customized checkout experience and generate a checkout URL that we can share!</p>
<h2>Headers and additional behavior</h2>
<p>In the <code>Configuration</code> tab, we can set all the basic details about the lock. In the following example, we set the title to <code>Demo x Panda</code> and we can see it reflect on the preview. We can also set a custom icon.</p>
<p>In order to generate a checkout URL, we need to add one or more locks. To do this, we can switch to the <code>Locks</code> tab.</p>
<p><img src="/images/blog/checkout-builder-release/header-checkout.gif" alt="Header Checkout"></p>
<h2>Add locks</h2>
<p>To add locks, the first thing we need to do is select a <code>Network</code> and the <code>Lock</code> we want to add.</p>
<p>The <code>Lock</code> dropdown will automatically show the list of our locks for every network.</p>
<p><img src="/images/blog/checkout-builder-release/add-lock.png" alt="Add Lock Header"></p>
<p><img src="/images/blog/checkout-builder-release/add-lock-1.png" alt="Add Lock Selection"></p>
<p>When the lock is selected, we can see it displayed in real-time on the preview.</p>
<p><img src="/images/blog/checkout-builder-release/lock-list.png" alt="Lock List"></p>
<p>As described in the previous step, we can follow the same process in order to add additional locks to our checkout page, if needed.</p>
<h3>Detailed membership configuration</h3>
<p>Our membership may have a number of traits that we’ll want to represent in the smart contract. Let’s take scenario:</p>
<p><em>"We need a Lock that sets our membership to renew 2 times, sets a maximum number of five memberships an individual user can purchase in a single wallet, and requires an email address so we can communicate with the member via email.”</em></p>
<p>The above items are configured in the <code>Settings</code> section of the Checkout Builder:</p>
<p><img src="/images/blog/checkout-builder-release/settings.png" alt="Lock List"></p>
<p>And finally, when the lock is added with the <code>Settings</code>, we can see <code>second lock demo</code> now contains all the details we added.</p>
<p><img src="/images/blog/checkout-builder-release/locks-list-multiple.png" alt="Lock Settings"></p>
<h2>Removing a lock from the checkout</h2>
<p>A lock can be removed from the checkout experience by clicking the cross icon on the lock list.</p>
<p><img src="/images/blog/checkout-builder-release/remove-lock.png" alt="Remove Lock Overview"></p>
<p><img src="/images/blog/checkout-builder-release/remove-lock-animation.gif" alt="Remove Lock GIF"></p>
<h2>Collecting metadata</h2>
<p>When setting up a membership experience, there is often information about your members (”metadata”) that is required to communicate with them (e.g. address), reward them (e.g. t-shirt size), and otherwise have a richer understanding of who a member is.</p>
<p>When collecting metadata during the checkout flow, you can set metadata items to collect at checkout time by clicking <code>Add metadata</code> in the Checkout Builder.</p>
<p>When <code>Add metadata</code> is enabled, a form where you can add detail for the metadata will be displayed. For each item of metadata, a number of fields are required.</p>
<ul>
<li><code>name</code>: the name of the field that's shown as a label</li>
<li><code>default value</code>: default value of the field</li>
<li><code>type</code>: type of the field</li>
<li><code>required</code>: specify if the field is required when true</li>
<li><code>placeholder</code>: the placeholder that's shown in the input type</li>
<li><code>public</code>: if this item of metadata should be visible to everyone</li>
</ul>
<h3>Add metadata</h3>
<p><img src="/images/blog/checkout-builder-release/metadata.png" alt="Add Metadata"></p>
<h3>Metadata on preview</h3>
<p><img src="/images/blog/checkout-builder-release/metadata-preview.png" alt="Metadata Preview"></p>
<h2>Copy and share!</h2>
<p>That's all! You have now configured a checkout flow that can be shared with your prospective members. You can now copy the generated URL and share it to your community on your website, via social media, through email, or by any other method you like.</p>
<p><img src="/images/blog/checkout-builder-release/copy-link-builder.gif" alt="Checkout Builder Demo Animation"></p>
<h2>One more thing: Developers can download the JSON configuration for a checkout</h2>
<p>While the above steps are especially helpful for creators who are creating memberships for their community, the Checkout Builder can be a huge time-saver for developers as well. If you are developing on top of Unlock Protocol and need to integrate a checkout configuration into your custom code, you can configure the checkout experience using the Checkout Builder and then download a fully-configured JSON file to <a href="https://docs.unlock-protocol.com/tools/paywall/locking-page/#configure-the-paywall">configure the Paywall</a> in your application.</p>
<p><img src="/images/blog/checkout-builder-release//download-json.png" alt="Download JSON"></p>
<p><strong>What if I find an issue or bug in the new checkout builder?</strong></p>
<p>Please open an issue on Github or tell us in Discord and we'll fix it ASAP.</p>



We are pleased to announce that a new version of the Unlock protocol template contract is now available.

### Whats is the PublicLock template?

In the Unlock Protocol, a “lock” is a standalone smart contract that can issue (mint) and manage membership NFTs (”keys”). Once deployed, each lock exists as an entirely separate and independent contract. Even if the protocol changes, lock contracts remain as they were when created. Since version 10, a lock can be [upgraded](./upgradeable-patterns) to a newer version which may change some of the features, without affecting the existing data.

Each new lock created is a “copy” of the main template contract, called `PublicLock`. The template contract defines the inner workings and the logic (functions, variables, etc.) of each new lock contract that is deployed. The template evolves as new use cases and features are added to the protocol.

### What changed in v12?

The version 12 contract consolidates the new features and approaches that were introduced in versions 10 and 11. The various features to set metadata (name, symbol and tokenURIs) have been regrouped into a single function called `setLockMetadata`. The configuration for a key’s default duration and available quantity (both per user and in aggregate) have also been grouped in a single `updateLockConfig` function. Additionally, several events are now fired when changes to the contract state are made — so those events are now easier to track using our [new subgraph](./subgraph-v2). Also, version 12 contains bug fixes related to locks with cancelled keys.

You can see a full list of related [issues and pull requests](https://github.com/unlock-protocol/unlock/issues?q=+label%3A%22publicLock+v12%22+) here.

### How to deploy or upgrade an existing smart contract

The version 12 template has been published and will soon be available as the default version for all new locks. Meanwhile, you can upgrade an existing version 11 lock by using the `upgradeLock` function from the Unlock factory contract. (To determine the current version of your lock, please check the `publicLockVersion` of your lock in your block explorer.)

As always, if you have any questions, please reach out to us on Discord and we’ll be happy to help you with the upgrade!

**Implementation note:** Version upgrades are only permitted to bump a single digit at a time. For example, if you have a v10 lock, you will have to upgrade first to v11, and then to v12.


New capabilities and improvements come to Unlock’s template smart contract for managing memberships.

Unlock Releases PublicLock v12 Smart Contract

<p>We are pleased to announce that a new version of the Unlock protocol template contract is now available.</p>
<h3>Whats is the PublicLock template?</h3>
<p>In the Unlock Protocol, a “lock” is a standalone smart contract that can issue (mint) and manage membership NFTs (”keys”). Once deployed, each lock exists as an entirely separate and independent contract. Even if the protocol changes, lock contracts remain as they were when created. Since version 10, a lock can be <a href="./upgradeable-patterns">upgraded</a> to a newer version which may change some of the features, without affecting the existing data.</p>
<p>Each new lock created is a “copy” of the main template contract, called <code>PublicLock</code>. The template contract defines the inner workings and the logic (functions, variables, etc.) of each new lock contract that is deployed. The template evolves as new use cases and features are added to the protocol.</p>
<h3>What changed in v12?</h3>
<p>The version 12 contract consolidates the new features and approaches that were introduced in versions 10 and 11. The various features to set metadata (name, symbol and tokenURIs) have been regrouped into a single function called <code>setLockMetadata</code>. The configuration for a key’s default duration and available quantity (both per user and in aggregate) have also been grouped in a single <code>updateLockConfig</code> function. Additionally, several events are now fired when changes to the contract state are made — so those events are now easier to track using our <a href="./subgraph-v2">new subgraph</a>. Also, version 12 contains bug fixes related to locks with cancelled keys.</p>
<p>You can see a full list of related <a href="https://github.com/unlock-protocol/unlock/issues?q=+label%3A%22publicLock+v12%22+">issues and pull requests</a> here.</p>
<h3>How to deploy or upgrade an existing smart contract</h3>
<p>The version 12 template has been published and will soon be available as the default version for all new locks. Meanwhile, you can upgrade an existing version 11 lock by using the <code>upgradeLock</code> function from the Unlock factory contract. (To determine the current version of your lock, please check the <code>publicLockVersion</code> of your lock in your block explorer.)</p>
<p>As always, if you have any questions, please reach out to us on Discord and we’ll be happy to help you with the upgrade!</p>
<p><strong>Implementation note:</strong> Version upgrades are only permitted to bump a single digit at a time. For example, if you have a v10 lock, you will have to upgrade first to v11, and then to v12.</p>



It was **1971** when Ray Tomlinson invented and developed electronic mail, as we know it today, by creating ARPANET's networked email system. It is one of the Internet’s oldest and (still!) most widely-used applications, with four [billion daily emails](https://blog.hubspot.com/marketing/email-marketing-stats)! Email predates the web, and predates the blockchain era. Over the years, it has seen many competing platforms come and go, but, for better or worse, email has remained the most frequently-used communication tool because it relies on open and decentralized protocols like [POP](https://en.wikipedia.org/wiki/Post_Office_Protocol), [SMTP](https://en.wikipedia.org/wiki/Simple_Mail_Transfer_Protocol) and [IMAP](https://en.wikipedia.org/wiki/Internet_Message_Access_Protocol).

![Email required](/images/blog/email-required/email-required-share.png)

As of now, web3 still does not have a widely-used alternative messaging protocol, which means that email is the best option for creators to reach to their members and communities.

At Unlock, when using our [checkout flow](https://docs.unlock-protocol.com/tools/checkout/) (which is [completely optional](https://docs.unlock-protocol.com/getting-started/unlock-without-frontend)), creators can choose to require purchasers to enter their email addresses at purchase (mint) time. This has been possible for a long time through the use of our [“metadata” collection mechanism](https://docs.unlock-protocol.com/tools/checkout/collecting-metadata), and we now have simplified this experience for creators by making email address collection an option when building a checkout URL by using `emailRequired` in the lock options.

![Email required](/images/blog/email-required/collecting-email.png)

You can test it out by getting a free Unlock community membership, if you don't already have one! [Click here](https://app.unlock-protocol.com/checkout?redirectUri=https%3A%2F%2Funlock-protocol.com%2Fblog%2Femail-required&paywallConfig=%7B%22network%22%3A1%2C%22pessimistic%22%3Atrue%2C%22locks%22%3A%7B%220xCE62D71c768aeD7EA034c72a1bc4CF58830D9894%22%3A%7B%22name%22%3A%22Unlock%20Community%22%2C%22network%22%3A100%2C%22emailRequired%22%3Atrue%7D%7D%2C%22icon%22%3A%22https%3A%2F%2Fraw.githubusercontent.com%2Funlock-protocol%2Funlock%2Fmaster%2Fdesign%2Fbrand%2F1808-Unlock-Identity_Unlock-WordMark.svg%22%2C%22callToAction%22%3A%7B%22default%22%3A%22Get%20an%20Unlock%20membership%20to%20access%20our%20Discord%2C%20blog%20comments%20and%20more!%20No%20xDAI%20to%20pay%20for%20gas%3F%20Click%20the%20Claim%20button.%22%7D%7D)!

Once collected, the email address is tied to the NFT owner address, and is only accessible by the lock manager through the Unlock Dashboard or through our Locksmith API.

One of the common questions that creators have in the web3 space is “how do I stay connected and engaged with my members and NFT-holders?” We know that this new feature can help!

**Implementation note:** Of course, since the email address is tied to the NFT owner’s wallet address, if the NFT is transferred, the email address is not accessible anymore.


Lock managers can configure Unlock's checkout UI to collect their members' email addresses.

Now there's a way to keep in touch with your members!

New Feature! Easy Email Collection for Creators

<p>It was <strong>1971</strong> when Ray Tomlinson invented and developed electronic mail, as we know it today, by creating ARPANET's networked email system. It is one of the Internet’s oldest and (still!) most widely-used applications, with four <a href="https://blog.hubspot.com/marketing/email-marketing-stats">billion daily emails</a>! Email predates the web, and predates the blockchain era. Over the years, it has seen many competing platforms come and go, but, for better or worse, email has remained the most frequently-used communication tool because it relies on open and decentralized protocols like <a href="https://en.wikipedia.org/wiki/Post_Office_Protocol">POP</a>, <a href="https://en.wikipedia.org/wiki/Simple_Mail_Transfer_Protocol">SMTP</a> and <a href="https://en.wikipedia.org/wiki/Internet_Message_Access_Protocol">IMAP</a>.</p>
<p><img src="/images/blog/email-required/email-required-share.png" alt="Email required"></p>
<p>As of now, web3 still does not have a widely-used alternative messaging protocol, which means that email is the best option for creators to reach to their members and communities.</p>
<p>At Unlock, when using our <a href="https://docs.unlock-protocol.com/tools/checkout/">checkout flow</a> (which is <a href="https://docs.unlock-protocol.com/getting-started/unlock-without-frontend">completely optional</a>), creators can choose to require purchasers to enter their email addresses at purchase (mint) time. This has been possible for a long time through the use of our <a href="https://docs.unlock-protocol.com/tools/checkout/collecting-metadata">“metadata” collection mechanism</a>, and we now have simplified this experience for creators by making email address collection an option when building a checkout URL by using <code>emailRequired</code> in the lock options.</p>
<p><img src="/images/blog/email-required/collecting-email.png" alt="Email required"></p>
<p>You can test it out by getting a free Unlock community membership, if you don't already have one! <a href="https://app.unlock-protocol.com/checkout?redirectUri=https%3A%2F%2Funlock-protocol.com%2Fblog%2Femail-required&#x26;paywallConfig=%7B%22network%22%3A1%2C%22pessimistic%22%3Atrue%2C%22locks%22%3A%7B%220xCE62D71c768aeD7EA034c72a1bc4CF58830D9894%22%3A%7B%22name%22%3A%22Unlock%20Community%22%2C%22network%22%3A100%2C%22emailRequired%22%3Atrue%7D%7D%2C%22icon%22%3A%22https%3A%2F%2Fraw.githubusercontent.com%2Funlock-protocol%2Funlock%2Fmaster%2Fdesign%2Fbrand%2F1808-Unlock-Identity_Unlock-WordMark.svg%22%2C%22callToAction%22%3A%7B%22default%22%3A%22Get%20an%20Unlock%20membership%20to%20access%20our%20Discord%2C%20blog%20comments%20and%20more!%20No%20xDAI%20to%20pay%20for%20gas%3F%20Click%20the%20Claim%20button.%22%7D%7D">Click here</a>!</p>
<p>Once collected, the email address is tied to the NFT owner address, and is only accessible by the lock manager through the Unlock Dashboard or through our Locksmith API.</p>
<p>One of the common questions that creators have in the web3 space is “how do I stay connected and engaged with my members and NFT-holders?” We know that this new feature can help!</p>
<p><strong>Implementation note:</strong> Of course, since the email address is tied to the NFT owner’s wallet address, if the NFT is transferred, the email address is not accessible anymore.</p>



![CSV airdrop](/images/blog/unlock-csv-airdrop/main.png)

Many creators and event organizers want to airdrop NFTs in bulk. To make this easier, we’ve added the ability to upload a spreadsheet (CSV) containing recipients and metadata.

After you upload the spreadsheet, we will show you a list of addresses with the number of NFT keys to be airdropped to them. We automatically remove duplicates, invalid entries, resolve ENS names, and run validation before showing the members.

![Members](/images/blog/unlock-csv-airdrop/members.png)

If you want to store additional metadata, you can put it as a column and fill in the value, which will be automatically added. To make it public, `.public` suffix can also be added.

We’re excited to bring more no-code tools to lock managers so they can easily manage members!


Creators can now upload a spreadsheet of recipients and metadata to airdrop NFTs directly to multiple recipients.

Creators can now upload a spreadsheet of recipients and metadata to airdrop NFTs directly to multiple recipients

Unlock Dashboard Now Supports Airdropping NFTs in Bulk

<p><img src="/images/blog/unlock-csv-airdrop/main.png" alt="CSV airdrop"></p>
<p>Many creators and event organizers want to airdrop NFTs in bulk. To make this easier, we’ve added the ability to upload a spreadsheet (CSV) containing recipients and metadata.</p>
<p>After you upload the spreadsheet, we will show you a list of addresses with the number of NFT keys to be airdropped to them. We automatically remove duplicates, invalid entries, resolve ENS names, and run validation before showing the members.</p>
<p><img src="/images/blog/unlock-csv-airdrop/members.png" alt="Members"></p>
<p>If you want to store additional metadata, you can put it as a column and fill in the value, which will be automatically added. To make it public, <code>.public</code> suffix can also be added.</p>
<p>We’re excited to bring more no-code tools to lock managers so they can easily manage members!</p>



Locksmith is our backend service. It is used for handling metadata, NFT ticketing, processing payments, [Unlock accounts](https://docs.unlock-protocol.com/tools/sign-in-with-ethereum/unlock-accounts/) and other features.

Many developers have asked for documentation and tooling to interact with Locksmith to build applications or to automate various tasks such as updating metadata in bulk, adding ticket verifiers, and more. Since it would be unwieldy to handle all of these use cases on our frontend without increasing complexity, we are releasing an [OpenAPI](https://www.openapis.org/) spec for our endpoints and a client SDK in `unlock-protocol/unlock-js`.

Our [docs site](https://docs.unlock-protocol.com) has been updated to show endpoints relevant to developers with examples and usage.

![docs explorer](/images/blog/open-api-support/docs.png)

Here is an example of how you can use the new Locksmith service client. It is fully typed so you will get intellisense for arguments and responses in your editor.

```js
import { LocksmithService } from '@unlock-protocol/unlock-js'

const service = new LocksmithService()

async function main() {
  // Get unlock address balance on each network
  const balanceResponse = await service.balance()
  console.log(balanceResponse)
  // Get keys metadata on goerli.
  const keysResponse = await service.keysMetadata(
    5,
    '0xb77030a7e47a5eb942a4748000125e70be598632',
    '1'
  )
  console.log(keysResponse)
}

main()
```

Note: It is experimental so expect breaking changes until `@unlock-protocol/unlock-js` reaches v1.x.

For languages other than JavaScript, you can use our [OpenAPI spec](https://github.com/unlock-protocol/unlock/blob/master/packages/unlock-js/openapi.yml) and generate a client using the [OpenAPI generator](https://openapi-generator.tech/).

If you have any feedback or find an outdated [OpenAPI spec](https://github.com/unlock-protocol/unlock/blob/master/packages/unlock-js/openapi.yml) for any of our public endpoints, please open an issue on Github.


Explore all our APIs and play around with the Locksmith client.

Explore all our APIs and play around with the Locksmith client

Unlock Adds OpenAPI Support and TypeScript Client For Locksmith

<p>Locksmith is our backend service. It is used for handling metadata, NFT ticketing, processing payments, <a href="https://docs.unlock-protocol.com/tools/sign-in-with-ethereum/unlock-accounts/">Unlock accounts</a> and other features.</p>
<p>Many developers have asked for documentation and tooling to interact with Locksmith to build applications or to automate various tasks such as updating metadata in bulk, adding ticket verifiers, and more. Since it would be unwieldy to handle all of these use cases on our frontend without increasing complexity, we are releasing an <a href="https://www.openapis.org/">OpenAPI</a> spec for our endpoints and a client SDK in <code>unlock-protocol/unlock-js</code>.</p>
<p>Our <a href="https://docs.unlock-protocol.com">docs site</a> has been updated to show endpoints relevant to developers with examples and usage.</p>
<p><img src="/images/blog/open-api-support/docs.png" alt="docs explorer"></p>
<p>Here is an example of how you can use the new Locksmith service client. It is fully typed so you will get intellisense for arguments and responses in your editor.</p>
<pre><code class="language-js">import { LocksmithService } from '@unlock-protocol/unlock-js'

const service = new LocksmithService()

async function main() {
  // Get unlock address balance on each network
  const balanceResponse = await service.balance()
  console.log(balanceResponse)
  // Get keys metadata on goerli.
  const keysResponse = await service.keysMetadata(
    5,
    '0xb77030a7e47a5eb942a4748000125e70be598632',
    '1'
  )
  console.log(keysResponse)
}

main()
</code></pre>
<p>Note: It is experimental so expect breaking changes until <code>@unlock-protocol/unlock-js</code> reaches v1.x.</p>
<p>For languages other than JavaScript, you can use our <a href="https://github.com/unlock-protocol/unlock/blob/master/packages/unlock-js/openapi.yml">OpenAPI spec</a> and generate a client using the <a href="https://openapi-generator.tech/">OpenAPI generator</a>.</p>
<p>If you have any feedback or find an outdated <a href="https://github.com/unlock-protocol/unlock/blob/master/packages/unlock-js/openapi.yml">OpenAPI spec</a> for any of our public endpoints, please open an issue on Github.</p>



Unlock Protocol sponsored the [ETHGlobal ETHOnline hackathon](https://online.ethglobal.com/) last month and there were many creative submissions for prizes that we’re excited to tell you about!

First, we’d like to give a shout-out to a number of participating teams we think did a really amazing job. All of these projects were very exciting and interesting use cases for Unlock Protocol.

## Runners-up

- [Subgrounds](https://ethglobal.com/showcase/unlock-protocol-subgrounds-gyhj8) showed us the potential of using Python for doing data analytics against Unlock subgraphs.
- [3toN](https://ethglobal.com/showcase/3ton-ftzq1) built a web3 pay-per-view Dapp using Unlock Protocol for [web3 subscriptions](https://unlock-protocol.com/blog/recurring-subscription-nft).
- [Streamharbour](https://ethglobal.com/showcase/streamharbour-h1uqk) built a tool for streamers to monetize their content, accept donations, and communicate with their fans — and also won prizes from Covalent, XMTP and IPFS.

Now, let's see the Unlock hackathon prize winners!

## Impact Self - 3rd place

The third place prize went to [Impact Self](https://ethglobal.com/showcase/impact-self-n5y5t). Impact Self built a platform for generating an environmental impact score on-chain. The score provides a quantifiable way for individuals to communicate their climate-positive actions and contributes to their sovereign web3 identity.

## Raindrop - 2nd place

The [Raindrop](https://ethglobal.com/showcase/raindrop-omz63) team created a decentralized platform alternative to subscription sites like Patreon or OnlyFans. Raindrop’s approach enables creatives to connect with their fans without the worry of being censored or de-platformed or having to worry about the portability of their user data.

[![raindrop.jpeg](/images/blog/ethonline-2022/raindrop.jpeg)](https://medium.com/@hidetaka.ko/summary-of-what-we-learned-from-protocol-who-developed-a-web3-version-of-patreon-at-ethonline-and-a0e4d1815952)

This team won several other prizes during this event including ones from Worldcoin, Livepeer and IPFS. [You can read more about their experience building on Unlock here](https://medium.com/@hidetaka.ko/summary-of-what-we-learned-from-protocol-who-developed-a-web3-version-of-patreon-at-ethonline-and-a0e4d1815952).

I think you’ll find that if you choose to build on Unlock Protocol, you’ll see the same thing that Raindrop’s Hidetaka Ko did when he said _“I was impressed that they were quicker and more polite than any other protocol.”_ I’m proud to say we have a supportive and encouraging community, not just the core team but the other people building who give back regularly because they embrace the WAGMI vision.

We hope that the Raindrop team continues their journey building on Unlock Protocol!

## Homebase - 1st place

Our first-prize winner, [Homebase](https://ethglobal.com/showcase/homebase-4kyoh), set out to tackle monetization for creators, a sweet spot for the use of Unlock Protocol. In contrast to Raindrop, Homebase focused on the social aspect and introduced social graph functionality through [Lens Protocol](https://lens.xyz/). In addition to implementing Unlock, Homebase paired with Next.js, The Graph, IPFS and Google Firebase. (Note: Unlock has integrations with [Firebase](https://david-layton.gitbook.io/novum/) and [many other](https://unlock-protocol.com/guides/category/plugins/) existing web2 and web3 tools. Interoperability continues to be a core reason people build on Unlock Protocol.)

[![homebase.png](/images/blog/ethonline-2022/homebase.png)](https://ethglobal.com/showcase/homebase-4kyoh)

Homebase did a beautiful job thinking through the design and flow of their application and it’s certainly the type of social platform I’d like to see more of.

If you’re interested in joining a hackathon where you can get some experience building in web3 on Unlock Protocol, come hack with us at [ETH San Francisco](https://sf.ethglobal.com/)! That said, you don’t need to be at an event to learn from us or ask questions. Join the Unlock Locksmith community by jumping into our [Discord](http://discord.unlock-protocol.com) server, where you’ll find the veteran builders and core team hanging out, answering questions, talking about the future of web3 and just generally supporting each other.


Here are the projects that walked away with prizes from Unlock Protocol.

Here are the projects that walked away with prizes from Unlock Protocol

ETHGlobal ETHOnline 2022 Hackathon Winners

<p>Unlock Protocol sponsored the <a href="https://online.ethglobal.com/">ETHGlobal ETHOnline hackathon</a> last month and there were many creative submissions for prizes that we’re excited to tell you about!</p>
<p>First, we’d like to give a shout-out to a number of participating teams we think did a really amazing job. All of these projects were very exciting and interesting use cases for Unlock Protocol.</p>
<h2>Runners-up</h2>
<ul>
<li><a href="https://ethglobal.com/showcase/unlock-protocol-subgrounds-gyhj8">Subgrounds</a> showed us the potential of using Python for doing data analytics against Unlock subgraphs.</li>
<li><a href="https://ethglobal.com/showcase/3ton-ftzq1">3toN</a> built a web3 pay-per-view Dapp using Unlock Protocol for <a href="https://unlock-protocol.com/blog/recurring-subscription-nft">web3 subscriptions</a>.</li>
<li><a href="https://ethglobal.com/showcase/streamharbour-h1uqk">Streamharbour</a> built a tool for streamers to monetize their content, accept donations, and communicate with their fans — and also won prizes from Covalent, XMTP and IPFS.</li>
</ul>
<p>Now, let's see the Unlock hackathon prize winners!</p>
<h2>Impact Self - 3rd place</h2>
<p>The third place prize went to <a href="https://ethglobal.com/showcase/impact-self-n5y5t">Impact Self</a>. Impact Self built a platform for generating an environmental impact score on-chain. The score provides a quantifiable way for individuals to communicate their climate-positive actions and contributes to their sovereign web3 identity.</p>
<h2>Raindrop - 2nd place</h2>
<p>The <a href="https://ethglobal.com/showcase/raindrop-omz63">Raindrop</a> team created a decentralized platform alternative to subscription sites like Patreon or OnlyFans. Raindrop’s approach enables creatives to connect with their fans without the worry of being censored or de-platformed or having to worry about the portability of their user data.</p>
<p><a href="https://medium.com/@hidetaka.ko/summary-of-what-we-learned-from-protocol-who-developed-a-web3-version-of-patreon-at-ethonline-and-a0e4d1815952"><img src="/images/blog/ethonline-2022/raindrop.jpeg" alt="raindrop.jpeg"></a></p>
<p>This team won several other prizes during this event including ones from Worldcoin, Livepeer and IPFS. <a href="https://medium.com/@hidetaka.ko/summary-of-what-we-learned-from-protocol-who-developed-a-web3-version-of-patreon-at-ethonline-and-a0e4d1815952">You can read more about their experience building on Unlock here</a>.</p>
<p>I think you’ll find that if you choose to build on Unlock Protocol, you’ll see the same thing that Raindrop’s Hidetaka Ko did when he said <em>“I was impressed that they were quicker and more polite than any other protocol.”</em> I’m proud to say we have a supportive and encouraging community, not just the core team but the other people building who give back regularly because they embrace the WAGMI vision.</p>
<p>We hope that the Raindrop team continues their journey building on Unlock Protocol!</p>
<h2>Homebase - 1st place</h2>
<p>Our first-prize winner, <a href="https://ethglobal.com/showcase/homebase-4kyoh">Homebase</a>, set out to tackle monetization for creators, a sweet spot for the use of Unlock Protocol. In contrast to Raindrop, Homebase focused on the social aspect and introduced social graph functionality through <a href="https://lens.xyz/">Lens Protocol</a>. In addition to implementing Unlock, Homebase paired with Next.js, The Graph, IPFS and Google Firebase. (Note: Unlock has integrations with <a href="https://david-layton.gitbook.io/novum/">Firebase</a> and <a href="https://unlock-protocol.com/guides/category/plugins/">many other</a> existing web2 and web3 tools. Interoperability continues to be a core reason people build on Unlock Protocol.)</p>
<p><a href="https://ethglobal.com/showcase/homebase-4kyoh"><img src="/images/blog/ethonline-2022/homebase.png" alt="homebase.png"></a></p>
<p>Homebase did a beautiful job thinking through the design and flow of their application and it’s certainly the type of social platform I’d like to see more of.</p>
<p>If you’re interested in joining a hackathon where you can get some experience building in web3 on Unlock Protocol, come hack with us at <a href="https://sf.ethglobal.com/">ETH San Francisco</a>! That said, you don’t need to be at an event to learn from us or ask questions. Join the Unlock Locksmith community by jumping into our <a href="http://discord.unlock-protocol.com">Discord</a> server, where you’ll find the veteran builders and core team hanging out, answering questions, talking about the future of web3 and just generally supporting each other.</p>



We were happy to participate in
[Gitcoin's Grants Round 15](https://gitcoin.co/grants/) as a sponsor of a $25k
pool for the greater Unlock ecosystem and another $10k added to the larger DEI
pool! There are some really exciting numbers to share about what we saw this
round. Gitcoin distributed $4.2 million dollars in funding and saw contributions
from 39.6k community donors. Unlock Protocol doubled the number of grantees in
our ecosystem going from 14 to 28.

![Gitcoin's GR 15](/images/blog/gitcoin-round-15.png)

Not only were we excited to see the number of grant applications increase in our
ecosystem we were really excited to see the diversity in the types of initiatives
tagging us in.

## Climate Change

We're sure that launching Unlock Protocol on the [Celo](https://celo.org/)
network is why we saw many more projects this round focused on climate change.
[Bloom Network](https://bloomnetwork.org/) continues to be the most well
supported project in both climate change and in the entire ecosystem. So far
they've raised more than $81k through Gitcoin Grants and we're so glad to see the
progress they've made with that funding. Some other projects with great potential
for climate impact are [Green Academy](https://green-academy.webflow.io/),
[Plants & Pillars](https://www.plantsandpillars3.com/),
[dMeter](https://dmeter.super.site/) and [Foresta](https://foresta.live/).

## DeSci

Some impressive projects leveraging Unlock Protocol for decentralized science,
or DeSci, tagged us in this round.
[Omni Analytics](https://twitter.com/omnianalytics) maintaining the top spot for
community support in this category, has continued to use the funding they've
recieved by adding more content to their "Learning Data Science on the Ethereum
Blockchain" course. Congratulations to
[Active Inference Institute](https://www.activeinference.org/) who caught
community attention with their plans to create a first of its kind open-source
package Active Blockference which aims to implement Active Inference simulations
for congnitive modeling for the blockchain space, use Active Blockference to
understand behavior in ETH/Web3 ecosystems and improve educational materials
around use of Active Blockference.

## web3 Social

We saw an increase in the number of web3 social projects taking advantage of
the power of Unlock Protocol too! [Nimi](https://nimi.io/) was a crowd favorite
with a dApp that allows you to aggregate your soical profiles. Other notable
projects include [Cobogo](https://cobogo.io) for creator profiles and
fundraising for the creator economy, [Maven Foundation](https://maven.foundation/)
is continuing their work on building tools to empower social influencers and
[MeTag](https://www.getmetag.io) is creating a scannable QR tag which is also NFC
enabled to help users share their web3 wallet information and social profiles.
[Headline](https://viaheadline.xyz/) a decentrailized publishing platform which
got its start with a [UDT Grant](https://docs.unlock-protocol.com/governance/grants-bounties-and-matchings) from Unlock Protocol jumped onto the Gitcoin
platform this round to continue their work.

## Education & Security

[VestLab](VestLab.io) is aiming to get you all the information about a crypto
project before you invest. [White Hat DAO](https://whitehatdao.com) is
looking to give deeper insights on blockchain projects with offerings that
include smart contract audits, safety ratings along with tokenomics analysis and
due-diligence. [Fractionalize](https://www.amwwaldorf.org) is implementing a
first-of-its-kind public education program to teach kids about web3 and NFTs and
the [Decentralized Library](https://decentralized-library.vercel.app/) will
include Unlock NFT library cards along with reading rewards stored in Unlock
NFTs for "proof of knowledge".

## Unicorns

We also some projects so unique we're daring to call theme unicorns.
[Trust Finance](https://www.trustfin.xyz) is looking to solve some challenges in
the traditional payroll and contractor payments space like slow posting times
and by making it easier for workers to invest a portion of their paychecks.
[Starksheet](https://www.starksheet.xyz/) is hoping to tackle some the largest
data silos by decentralizing business intelligence with a web3 spreadsheet
solution making use of Unlock NFTs.

## Diversity, Equity & Inclusion

Last but not least there were several projects both utilizing Unlock Protocol
and tackling Diversity, Equity & Inclusion (DEI) in web3. We continue to be
passionate about our support of these projects and we're so enthusiastic to see
so many in this round. Our friends over at [Blu3 DAO](https://www.blu3dao.com/)
continue to do such impressive work educating, preparing and sponsoring hackers
in the web3 space. The community seems to agree with our take on the work they
do, with hundreds of supporters and thousands of dollars in community support.
They were able to raise close to $60k this round with matching funds and we
couldn't be happier to see that happen for them!
[End Domestic Violence](https://EndDomesticViolence.Art) is on a mission to
create a powerful healing modality for domestic violence victims using art to
process trauma and is building an art workshop platform on Unlock Protocol to
deliver it. They continue to be the only grantee on the platform addressing the
issue of domestic violence so we're watching closely to see how the community
reacts to the progess they'll make between this round and next as they get off
the ground. Another project supporting women's reproductive rights while also
bringing you an innovative music experience is
[Beats Per Mint](https://tell.ie/beatspermint/j6upJTcHktEE) who will soon be
releasing their first collection _"Beam Me Down"_ and we couldn't be more
delighted to be enabling a truly feminist platform.


Unlock Labs 2nd Gitcoin round matched $25k in UDT tokens for projects in our ecosystem and another $10k for Diversity, Equity & Inclusion (DEI).

Unlock is funding public goods with UDT!

Gitcoin Grants Round 15

<p>We were happy to participate in
<a href="https://gitcoin.co/grants/">Gitcoin's Grants Round 15</a> as a sponsor of a $25k
pool for the greater Unlock ecosystem and another $10k added to the larger DEI
pool! There are some really exciting numbers to share about what we saw this
round. Gitcoin distributed $4.2 million dollars in funding and saw contributions
from 39.6k community donors. Unlock Protocol doubled the number of grantees in
our ecosystem going from 14 to 28.</p>
<p><img src="/images/blog/gitcoin-round-15.png" alt="Gitcoin&#x27;s GR 15"></p>
<p>Not only were we excited to see the number of grant applications increase in our
ecosystem we were really excited to see the diversity in the types of initiatives
tagging us in.</p>
<h2>Climate Change</h2>
<p>We're sure that launching Unlock Protocol on the <a href="https://celo.org/">Celo</a>
network is why we saw many more projects this round focused on climate change.
<a href="https://bloomnetwork.org/">Bloom Network</a> continues to be the most well
supported project in both climate change and in the entire ecosystem. So far
they've raised more than $81k through Gitcoin Grants and we're so glad to see the
progress they've made with that funding. Some other projects with great potential
for climate impact are <a href="https://green-academy.webflow.io/">Green Academy</a>,
<a href="https://www.plantsandpillars3.com/">Plants &#x26; Pillars</a>,
<a href="https://dmeter.super.site/">dMeter</a> and <a href="https://foresta.live/">Foresta</a>.</p>
<h2>DeSci</h2>
<p>Some impressive projects leveraging Unlock Protocol for decentralized science,
or DeSci, tagged us in this round.
<a href="https://twitter.com/omnianalytics">Omni Analytics</a> maintaining the top spot for
community support in this category, has continued to use the funding they've
recieved by adding more content to their "Learning Data Science on the Ethereum
Blockchain" course. Congratulations to
<a href="https://www.activeinference.org/">Active Inference Institute</a> who caught
community attention with their plans to create a first of its kind open-source
package Active Blockference which aims to implement Active Inference simulations
for congnitive modeling for the blockchain space, use Active Blockference to
understand behavior in ETH/Web3 ecosystems and improve educational materials
around use of Active Blockference.</p>
<h2>web3 Social</h2>
<p>We saw an increase in the number of web3 social projects taking advantage of
the power of Unlock Protocol too! <a href="https://nimi.io/">Nimi</a> was a crowd favorite
with a dApp that allows you to aggregate your soical profiles. Other notable
projects include <a href="https://cobogo.io">Cobogo</a> for creator profiles and
fundraising for the creator economy, <a href="https://maven.foundation/">Maven Foundation</a>
is continuing their work on building tools to empower social influencers and
<a href="https://www.getmetag.io">MeTag</a> is creating a scannable QR tag which is also NFC
enabled to help users share their web3 wallet information and social profiles.
<a href="https://viaheadline.xyz/">Headline</a> a decentrailized publishing platform which
got its start with a <a href="https://docs.unlock-protocol.com/governance/grants-bounties-and-matchings">UDT Grant</a> from Unlock Protocol jumped onto the Gitcoin
platform this round to continue their work.</p>
<h2>Education &#x26; Security</h2>
<p><a href="VestLab.io">VestLab</a> is aiming to get you all the information about a crypto
project before you invest. <a href="https://whitehatdao.com">White Hat DAO</a> is
looking to give deeper insights on blockchain projects with offerings that
include smart contract audits, safety ratings along with tokenomics analysis and
due-diligence. <a href="https://www.amwwaldorf.org">Fractionalize</a> is implementing a
first-of-its-kind public education program to teach kids about web3 and NFTs and
the <a href="https://decentralized-library.vercel.app/">Decentralized Library</a> will
include Unlock NFT library cards along with reading rewards stored in Unlock
NFTs for "proof of knowledge".</p>
<h2>Unicorns</h2>
<p>We also some projects so unique we're daring to call theme unicorns.
<a href="https://www.trustfin.xyz">Trust Finance</a> is looking to solve some challenges in
the traditional payroll and contractor payments space like slow posting times
and by making it easier for workers to invest a portion of their paychecks.
<a href="https://www.starksheet.xyz/">Starksheet</a> is hoping to tackle some the largest
data silos by decentralizing business intelligence with a web3 spreadsheet
solution making use of Unlock NFTs.</p>
<h2>Diversity, Equity &#x26; Inclusion</h2>
<p>Last but not least there were several projects both utilizing Unlock Protocol
and tackling Diversity, Equity &#x26; Inclusion (DEI) in web3. We continue to be
passionate about our support of these projects and we're so enthusiastic to see
so many in this round. Our friends over at <a href="https://www.blu3dao.com/">Blu3 DAO</a>
continue to do such impressive work educating, preparing and sponsoring hackers
in the web3 space. The community seems to agree with our take on the work they
do, with hundreds of supporters and thousands of dollars in community support.
They were able to raise close to $60k this round with matching funds and we
couldn't be happier to see that happen for them!
<a href="https://EndDomesticViolence.Art">End Domestic Violence</a> is on a mission to
create a powerful healing modality for domestic violence victims using art to
process trauma and is building an art workshop platform on Unlock Protocol to
deliver it. They continue to be the only grantee on the platform addressing the
issue of domestic violence so we're watching closely to see how the community
reacts to the progess they'll make between this round and next as they get off
the ground. Another project supporting women's reproductive rights while also
bringing you an innovative music experience is
<a href="https://tell.ie/beatspermint/j6upJTcHktEE">Beats Per Mint</a> who will soon be
releasing their first collection <em>"Beam Me Down"</em> and we couldn't be more
delighted to be enabling a truly feminist platform.</p>
