Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/solana-developers/compressed-nfts

Example code to use compressed NFTs (using state compression) on Solana
https://github.com/solana-developers/compressed-nfts

compressed-nfts compression metaplex nfts solana state-compression

Last synced: 23 days ago
JSON representation

Example code to use compressed NFTs (using state compression) on Solana

Awesome Lists containing this project

README 

        
# State Compression and Compressed NFTs



At a high level, state compression is a technique in which off-chain data is secured by the Solana

ledger, using a hashing algorithm to "fingerprint" the _off-chain_ data and storing it inside a

special _on-chain_ Merkle tree, called a Concurrent Merkle Tree.



With this technology, compressed NFTs can be created on-chain in a similar manner as before, but for

a fraction of the cost as before. As a frame of reference of on-chain cost reduction, take a 1

million NFT collection:



- traditional NFTs (aka non-compressed):

  - 1 million NFTs ~= 12,000 SOL

- compressed NFTs:

  - 1 million NFTs ~= 5 SOL



## Quick links to learn more



- Solana Docs for [State Compression](https://docs.solana.com/learn/state-compression)

- written guide

  [minting compressed NFTs](https://solana.com/developers/guides/javascript/compressed-nfts) (which

  is based on this repo)



## Tech stack of this repo



- uses TypeScript and NodeJS

- yarn (as the node package manager)



## Setup locally



1. Clone this repo to your local system

2. Install the packages via `yarn install`

3. Rename the `example.env` file to be named `.env`

4. Update the `RPC_URL` variable to be the cluster URL of a supporting RPC provider



If you have the Solana CLI installed locally: update the `LOCAL_PAYER_JSON_ABSPATH` environment

variable to be the **_absolute path_** of your local testing wallet keypair JSON file.



## Recommended flow to explore this repo



After setting up locally, I recommend exploring the code of the following files (in order):



1. [`./scripts/verboseCreateAndMint.ts`](./scripts/verboseCreateAndMint.ts)

2. [`./scripts/fetchNFTsByOwner.ts`](./scripts/fetchNFTsByOwner.ts)

3. [`./scripts/transferNFT.ts`](./scripts/transferNFT.ts)



After reviewing the code, then running each of these scripts in the same order.



> **Note:** Running each of these scripts will save some bits of data to a `.local_keys` folder

> within this repo for use by the other scripts later in this ordered list. Therefore, running them

> in a different order will result in them not working as written. You have been warned :)



### Running the included Scripts



Once you're setup locally, you will be able to run the scripts included within this repo:



```

yarn demo ./scripts/

```



#### `scripts/createAndMint.ts`



Performs all the following actions:



- create a new Merkle tree on-chain

- create a new NFT collection

- mint two compressed NFTs (to different addresses)



#### `scripts/verboseCreateAndMint.ts`



Functionally the same as `scripts/createAndMint.ts`. This script adds extra console logging and

comments for explanation purposes.



#### `scripts/fetchNFTsByOwner.ts`



Uses the ReadApi `fetchAssetsByOwner` method to fetch the NFTs owners by the two addresses.



#### `scripts/fetchNFTsByCollection.ts`



Uses the ReadApi `fetchAssetsByGroup` method to fetch the NFTs belonging to the same collection,

compressed or otherwise.



#### `scripts/transferNFT.ts`



Performs the complete process to transfer compressed NFTs. Specifically:



- fetching the NFT asset data from the RPC

- fetching the asset's proof from the RPC

- verifying the RPC provided proof on the client side

- builds the compressed NFT transfer function



#### `scripts/mintToCollection.ts`



Mint additional compressed NFTs into an already existing collection and/or tree.



## Metaplex sdk examples



This repo also contains code examples of how to use the

[`@metaplex-foundation/js`](https://www.npmjs.com/package/@metaplex-foundation/js) sdk to work with

compressed NFTs, including reading and transferring them.



After setting up locally, I recommend exploring the code of the following metaplex specific files

(in order):



1. [`./metaplex/mintToCollection.ts`](./metaplex/mintToCollection.ts)

2. [`./metaplex/transferNFT.ts`](./metaplex/transferNFT.ts)

3. [`./metaplex/fetchNFTsByOwner.ts`](./metaplex/fetchNFTsByOwner.ts)

4. [`./metaplex/simpleProofVerification.ts`](./metaplex/simpleProofVerification.ts)



#### `metaplex/mintToCollection.ts`



Mint a single compressed NFT to an existing tree and collection, using the metaplex sdk. This

requires you to create your tree and collection ahead of time. See the

[`./scripts/verboseCreateAndMint.ts`](./scripts/verboseCreateAndMint.ts) script for details on how

to create a tree and collection.



#### `metaplex/transferNFT.ts`



Transfer a compressed NFT using the metaplex sdk. This method only requires you to know the

`assetId` of the compressed NFT to transfer.



#### `metaplex/fetchNFTsByOwner.ts`



Uses the ReadApi `fetchAssetsByOwner` method to fetch the NFTs owned by a single address.



#### `metaplex/fetchNFTsByGroup.ts`



Uses the ReadApi `fetchAssetsByGroup` method to fetch the NFTs belonging to the same collection,

compressed or otherwise.



#### `metaplex/simpleProofVerification.ts`



Mint additional compressed NFTs into an already existing collection and/or tree.



## Resources on State Compression and Compressed NFTS



- Solana Docs:

  - [State Compression](https://edge.docs.solana.com/learn/state-compression)

  - [Guide for compressed NFTs](https://edge.docs.solana.com/developing/guides/compressed-nfts)

    (which is based on this repo)

- Account Compression SPL Program:

  - Documentation - https://spl.solana.com/account-compression

  - Repository -

    https://github.com/solana-labs/solana-program-library/tree/master/account-compression

- Metaplex Read API:

  - open spec:

    https://github.com/metaplex-foundation/api-specifications/tree/main/specifications/read_api

  - Playground - https://metaplex-read-api.surge.sh/

- Metaplex Compression examples:

  - https://github.com/metaplex-foundation/compression-read-api-js-examples

  - Bubblegum program - https://github.com/metaplex-foundation/mpl-bubblegum