Help & Support

Custom Feeds

This guide will introduce the concept of Custom Feeds and how to create and manage them.

This guide provides an introduction to the concept of Custom Feeds. More information will be provided in due course.

As mentioned in the Feed concept page, there are two classes of Feed instances:

  • The Global Feed: The familiar shared feed that aggregates all public Lens activity.

  • Custom Feeds: App or community-specific feeds that can be open or governed by Feed Rules.

Create a Custom Feed

To create an Feed, you need to:

  1. Create an Feed Metadata object

  2. Upload the Feed Metadata object onto a public URI.

  3. Deploy the Lens Feed smart contract.

See the Lens Metadata Standards guide for more information on creating and hosting Metadata objects.

1

Create Metadata

Use the @lens-protocol/metadata package to construct a valid FeedMetadata object:

Example
import { feed } from "@lens-protocol/metadata";
const metadata = feed({  name: "XYZ",  title: "Not Just Another Feed… or is it?",  description: "My custom feed description",});

2

Upload Metadata

Then, upload the Feed Metadata object to a public URI.

import { storageClient } from "./storage-client";
const { uri } = await storageClient.uploadAsJson(metadata);
console.log(uri); // e.g., lens://4f91ca…

This example uses Lens Storage to host the Metadata object. See the Lens Metadata Standards guide for more information on hosting Metadata objects.

3

Deploy Feed Contract

You MUST be authenticated as Builder to make this request.

Use the createFeed action to deploy the Lens Feed smart contract.

import { uri } from "@lens-protocol/client";import { createFeed } from "@lens-protocol/client/action";
const result = await createFeed(sessionClient, {  metadataUri: uri("lens://4f91ca…"),});

4

Handle Result

Finally, handle the result using the adapter for the library of your choice:

import { handleWith } from "@lens-protocol/client/viem";
// …
const result = await createFeed(sessionClient, {  metadataUri: uri("lens://4f91ca…"),}).andThen(handleWith(walletClient));

See the Transaction Lifecycle guide for more information on how to determine the status of the transaction.

Fetch a Feed

Use the fetchFeed action to fetch a single Feed by address or by transaction hash.

import { evmAddress } from "@lens-protocol/client";import { fetchFeed } from "@lens-protocol/client/actions";import { client } from "./client";
const result = await fetchFeed(client, {  address: evmAddress("0x1234…"),});
if (result.isErr()) {  return console.error(result.error);}
const feed = result.value;

Search Feeds

Use the paginated fetchFeeds action to search for feeds.

import { fetchFeeds } from "@lens-protocol/client/actions";
import { client } from "./client";
const result = await fetchFeeds(client, {  filter: {    searchBy: "feedName",  },});
if (result.isErr()) {  return console.error(result.error);}
// items: Array<Feed>const { items, pageInfo } = result.value;

Continue with the Pagination guide for more information on how to handle paginated results.

Previous
Post Rules
Next
Graphs