Library Overview

BuilderOSS Developer Libraries

The BuilderOSS ecosystem provides a comprehensive set of TypeScript libraries to help developers build applications that integrate with the Nouns Builder protocol. These libraries are designed to be modular, type-safe, and easy to use.

Available Packages

Core Libraries

@buildeross/sdk - Comprehensive SDK with contract ABIs, GraphQL clients, and blockchain utilities
@buildeross/hooks - React hooks for blockchain interactions, UI utilities, and data management
@buildeross/utils - Helper functions for blockchain operations, data formatting, and validation

Infrastructure & Configuration

@buildeross/constants - Shared constants, contract addresses, and configuration values
@buildeross/types - TypeScript type definitions for blockchain interactions and data structures
@buildeross/ipfs-service - IPFS utilities for file upload and content management

UI & Styling

@buildeross/zord - Modern design system and component library built with Vanilla Extract
@buildeross/analytics - Analytics integration for Google Analytics, Segment, and Vercel

Development Tools

@buildeross/eslint-config-custom - Shared ESLint configuration for consistent code quality
@buildeross/blocklist - Address validation against US Treasury SDN list

Quick Start

To get started with BuilderOSS libraries, install the packages you need:

# Core functionality
pnpm install @buildeross/sdk @buildeross/hooks @buildeross/utils

# UI components and styling
pnpm install @buildeross/zord

# Additional utilities
pnpm install @buildeross/constants @buildeross/types @buildeross/ipfs-service

Key Features

Type Safety

All packages are built with TypeScript and provide comprehensive type definitions for blockchain interactions, ensuring compile-time safety.

Multi-Chain Support

The libraries support all major networks where Builder protocol is deployed:

Ethereum Mainnet
Base
Optimism
Zora
Testnets (Sepolia, Base Sepolia, etc.)

React Integration

Built with React in mind, providing hooks and components that integrate seamlessly with modern React applications and Next.js.

Development Workflow

Start with the SDK - Use @buildeross/sdk for core blockchain interactions
Add React Hooks - Use @buildeross/hooks for React-specific functionality
Style with Zord - Use @buildeross/zord for consistent UI components
Enhance with Utilities - Use @buildeross/utils for data formatting and validation

Common Patterns

Fetching DAO Data

import { SubgraphSDK } from '@buildeross/sdk/subgraph'
import { useDaoAuction } from '@buildeross/hooks'

// In your component
const auction = useDaoAuction({
  collectionAddress: '0x...',
  auctionAddress: '0x...',
  chainId: CHAIN_ID.ETHEREUM
})

Building UI Components

import { Box, Stack, Text, Button } from '@buildeross/zord'

function MyComponent() {
  return (
    <Box p="x6" backgroundColor="background1" borderRadius="normal">
      <Stack gap="x4">
        <Text size="lg" weight="heading">DAO Name</Text>
        <Button variant="primary">Join Auction</Button>
      </Stack>
    </Box>
  )
}

Support

Documentation: Comprehensive documentation for each package
TypeScript: Full type definitions and IntelliSense support
Examples: Real-world usage examples in the main Nouns Builder application
Community: Join our Discord for support

License

All BuilderOSS libraries are released under the MIT License.