Feed functionality for Net Protocol - topic-based message streams
npm install @net-protocol/feedsStatus: In Development - Do not use yet. Will have breaking changes and may be incomplete.
Feed SDK for building topic-based message streams on Net Protocol.
Feeds are topic-based message streams built on Net Protocol. They use a simple convention:
- Messages are posted with appAddress: NULL_ADDRESS (global, not app-specific)
- Topics are prefixed with feed- (e.g., feed-crypto, feed-announcements)
- Anyone can read or post to any feed
This creates a decentralized social media system where:
- Topics are feeds: Each topic becomes a feed (like a subreddit or Twitter hashtag)
- Permissionless: Anyone can read or post
- Permanent: All posts are stored permanently on the blockchain
- Transparent: All posts are publicly verifiable
- Read feeds: Query posts from any topic-based feed
- Post to feeds: Create posts in feeds (social media style)
- Build social apps: Create decentralized social applications
- Community forums: Build discussion forums and community spaces
- Announcements: Create announcement feeds for projects or communities
Perfect for building decentralized alternatives to Twitter, Reddit, or Discord channels.
- Net Protocol Documentation - Complete protocol documentation
- How Net Works - Understanding the underlying messaging system
``bash`
npm install @net-protocol/feeds @net-protocol/core wagmi viem react
Read posts from a feed topic using a React hook:
`tsx
import { useFeedPosts } from "@net-protocol/feeds";
function FeedComponent() {
const { posts, totalCount, isLoading } = useFeedPosts({
chainId: 8453,
topic: "crypto", // Auto-prefixed to "feed-crypto"
maxMessages: 50,
});
if (isLoading) return
return (
}>
{post.text}
From: {post.sender}
$3
For non-React usage, use the
class:`ts
import { FeedClient } from "@net-protocol/feeds";const client = new FeedClient({ chainId: 8453 });
// Get feed posts
const posts = await client.getFeedPosts({
topic: "crypto",
maxPosts: 50,
});
// Get post count
const count = await client.getFeedPostCount("crypto");
// Prepare a post (does not submit - you submit using your wallet)
const config = client.preparePostToFeed({
topic: "crypto",
text: "Hello world!",
data: "netid-abc123", // Optional - can be storage key, JSON, or any string
});
// Then submit using your wallet library (wagmi, viem, etc.)
`API Reference
$3
React hook for fetching feed posts.
Parameters:
-
(number, required) - Chain ID to query
- topic (string, required) - Topic name (auto-prefixed with "feed-" if not already present)
- maxMessages (number, optional) - Maximum number of messages to fetch (default: 50)
- enabled (boolean, optional) - Whether the query is enabled (default: true)Returns:
-
posts (NetMessage[]) - Array of feed posts
- totalCount (number) - Total number of posts in the feed
- isLoading (boolean) - Loading stateNote: This hook does NOT return an
error field (for compatibility with useTopicFeed).$3
Client class for non-React feed interactions.
#### Constructor
`ts
new FeedClient({ chainId: number, overrides?: { rpcUrls: string[] } })
`#### Methods
- Gets feed posts for a topic
- Parameters:
- Returns:
- Gets the total count of posts in a feed
- Parameters:
- Returns:
- Prepares a transaction configuration for posting to a feed (does not submit)
- Parameters:
- Returns:
- Note: accepts any string (storage keys, JSON, arbitrary bytes) which will be converted to hexTopic Normalization
Topics are automatically normalized with the following rules:
- Case-insensitive: "CRYPTO" → "feed-crypto", "FEED-crypto" → "feed-crypto"
- Auto-prefix: Topics without "feed-" prefix are automatically prefixed
- Idempotent: Safe to call with already-prefixed topics
- Whitespace trimmed: Leading/trailing whitespace is removed
Examples:
-
normalizeFeedTopic("crypto") → "feed-crypto"
- → "feed-crypto"
- → "feed-crypto" (idempotent)
- normalizeFeedTopic("FEED-crypto") → "feed-crypto" (not "feed-feed-crypto")Error Handling
-
useFeedPosts: Does not return an error field (for compatibility with useTopicFeed)
- FeedClient: Methods propagate errors (consistent with NetClient pattern)
- Edge cases: Handled gracefully (empty topics, zero counts, negative maxMessages)Dependencies
- Required:
@net-protocol/core - For NetClient, useNetMessages, useNetMessageCount
- Required: viem - For stringToHex
- Peer dependencies: react, wagmi - For React hooksUtilities
$3
Normalizes a feed topic by ensuring it has the "feed-" prefix. Case-insensitive and idempotent.
$3
Checks if a topic is a feed topic (starts with "feed-" prefix, case-insensitive).
$3
Constant:
"feed-"Constants
If you need
for other purposes, import it from @net-protocol/core:`ts
import { NULL_ADDRESS } from "@net-protocol/core";
`Examples
$3
tsx
import { useFeedPosts } from "@net-protocol/feeds";function CryptoFeed() {
const { posts, totalCount, isLoading } = useFeedPosts({
chainId: 8453,
topic: "crypto",
maxMessages: 20,
});
return (
Crypto Feed ({totalCount} posts)
{isLoading ? (
Loading...
) : (
posts.map((post) => (
${post.sender}-${post.timestamp}}>
{post.text}
))
)}
);
}
`$3
tsx
import { FeedClient } from "@net-protocol/feeds";
import { useWriteContract } from "wagmi";function PostButton() {
const { writeContract } = useWriteContract();
const client = new FeedClient({ chainId: 8453 });
const handlePost = () => {
const config = client.preparePostToFeed({
topic: "crypto",
text: "Hello from the feed!",
});
writeContract(config);
};
return ;
}
`Migration from
If you're migrating from the Net repo's
hook:Before:
`tsx
import { useTopicFeed } from "@/components/hooks/net/useTopicFeed";
const { posts, totalCount, isLoading } = useTopicFeed({
chainId,
topic: feed-${userAddress},
maxMessages: 50,
});
`After:
tsx
import { useFeedPosts } from "@net-protocol/feeds";
const { posts, totalCount, isLoading } = useFeedPosts({
chainId,
topic: feed-${userAddress}, // Works with or without prefix
maxMessages: 50, // Same parameter name
});
``The API is fully compatible - same parameter names, same return shape, same defaults.