Freezing and Thawing Compressed NFTs

Summary

Freezing and thawing compressed NFTs controls transferability using Bubblegum V2's freeze instructions. This page covers freeze, delegate-and-freeze, thaw, thaw-and-revoke, and making cNFTs soulbound (non-transferable).

• Freeze a cNFT via a leaf delegate or permanent freeze delegate
• Delegate and freeze in a single transaction with delegateAndFreezeV2
• Thaw a frozen cNFT and optionally revoke the delegate in one step
• Make a cNFT permanently non-transferable (soulbound) with setNonTransferableV2

With Bubblegum V2, we can freeze and thaw Compressed NFTs. This is useful for various use cases, such as staking.

Freezing a Compressed NFT

To freeze a Compressed NFT that has been delegated to a leaf delegate before, we can use the freezeV2 instruction. If it has not been delegated yet, see delegateAndFreezeV2 below. The freezeV2 instruction can be used like this:

import {
  getAssetWithProof,
  freezeV2,
} from '@metaplex-foundation/mpl-bubblegum';

const assetWithProof = await getAssetWithProof(umi, assetId);
await freezeV2(umi, {
  ...assetWithProof,
  leafOwner: umi.identity.publicKey,
  authority: leafDelegate, // this would default to the payer
  leafDelegate: leafDelegate.publicKey,
  // If the cNFT is part of a collection, pass the collection address.
  //coreCollection: collectionSigner.publicKey,
}).sendAndConfirm(umi);

Delegate and Freeze a Compressed NFT

To freeze a Compressed NFT, we can use the delegateAndFreezeV2 instruction. This instruction can be used like this:

import {
  getAssetWithProof,
  delegateAndFreezeV2,
} from '@metaplex-foundation/mpl-bubblegum';

// newLeafDelegate should be a publicKey that will be able to thaw the cNFT later.

const assetWithProof = await getAssetWithProof(umi, assetId);
await delegateAndFreezeV2(umi, {
  ...assetWithProof,
  leafOwner: umi.identity.publicKey,
  newLeafDelegate,
}).sendAndConfirm(umi);

Thawing a Compressed NFT

To thaw a Compressed NFT, we can use the thawV2 instruction. This instruction can be used like this:

import {
  getAssetWithProof,
  thawV2,
} from '@metaplex-foundation/mpl-bubblegum';

const assetWithProof = await getAssetWithProof(umi, assetId);
// delegateAuthority should be a Signer that has been approved as a delegate authority for the cNFT.
await thawV2(umi, {
  ...assetWithProof,
  authority: delegateAuthority,
}).sendAndConfirm(umi);

If the cNFT has been delegated to a permanent freeze delegate, we can thaw it like this:

import {
  getAssetWithProof,
  thawV2,
} from '@metaplex-foundation/mpl-bubblegum';

const assetWithProof = await getAssetWithProof(umi, assetId);
await thawV2(umi, {
  ...assetWithProof,
  authority: permanentFreezeDelegate,
}).sendAndConfirm(umi);

Thaw and Revoke a Delegate Authority

To thaw and revoke a Delegate Authority at the same time, we can use the thawAndRevokeV2 instruction. This instruction can be used like this:

import {
  getAssetWithProof,
  thawAndRevokeV2,
} from '@metaplex-foundation/mpl-bubblegum';

// delegateAuthority should be a Signer that has been approved as a delegate authority for the cNFT.
const assetWithProof = await getAssetWithProof(umi, assetId);
await thawAndRevokeV2(umi, {
  ...assetWithProof,
  authority: delegateAuthority,
}).sendAndConfirm(umi);

Make a cNFT Soulbound

To make a cNFT Soulbound the cNFT has to be part of a mpl-core collection with the permanentFreezeDelegate Plugin. Using the setNonTransferableV2 instruction, we can make the cNFT non-transferable.

import {
  getAssetWithProof,
  setNonTransferableV2,
} from '@metaplex-foundation/mpl-bubblegum';

const assetWithProof = await getAssetWithProof(umi, assetId);

await setNonTransferableV2(umi, {
    ...assetWithProof,
    authority, // The permanent freeze delegate on collection
    coreCollection: collection.publicKey,
}).sendAndConfirm(umi);

Notes

• A cNFT must be delegated to a leaf delegate before it can be frozen with freezeV2. Use delegateAndFreezeV2 to do both in one transaction.
• The permanent freeze delegate operates at the collection level and requires the PermanentFreezeDelegate plugin on the collection.
• Soulbound (non-transferable) status set by setNonTransferableV2 is permanent and cannot be reversed.
• Frozen cNFTs cannot be transferred or burned by the owner. Only the freeze authority can thaw them.

FAQ

How do I freeze a compressed NFT?

Use freezeV2 with a leaf delegate or permanent freeze delegate. If the cNFT hasn't been delegated yet, use delegateAndFreezeV2 to delegate and freeze in one transaction.

What is the difference between a leaf delegate freeze and a permanent freeze?

A leaf delegate freeze is asset-level — the owner must delegate first. A permanent freeze delegate is collection-level — it can freeze any cNFT in the collection without owner interaction, if the PermanentFreezeDelegate plugin is enabled.

How do I make a cNFT soulbound?

Use setNonTransferableV2 with the permanent freeze delegate authority. The collection must have the PermanentFreezeDelegate plugin. This is permanent and cannot be reversed.

Can a soulbound cNFT be made transferable again?

No. The non-transferable flag is permanent. Once a cNFT is made soulbound, it cannot be transferred to another wallet.

Glossary