Installation

Package Installation

Install CreateKit using your preferred package manager:

bash
npm install @b3dotfun/basemint

bash
yarn add @b3dotfun/basemint

bash
pnpm add @b3dotfun/basemint

Dependencies

CreateKit is built on top of modern web3 technologies and requires the following peer dependencies:

bash
npm install viem @wagmi/core

bash
yarn add viem @wagmi/core

bash
pnpm add viem @wagmi/core

Environment Setup

1. Configure Chain Networks

CreateKit provides pre-configured chain definitions for B3 Mainnet:

typescript
import { b3Mainnet } from '@b3dotfun/basemint'console.log('Chain ID:', b3Mainnet.id) // 8333console.log('Name:', b3Mainnet.name)console.log('RPC URL:', b3Mainnet.rpcUrls.default.http[0])

2. Initialize Viem Client

Set up your viem client for interacting with the blockchain:

typescript
import { createPublicClient, createWalletClient, http } from 'viem'import { privateKeyToAccount } from 'viem/accounts'import { b3Mainnet } from '@b3dotfun/basemint'// Public client for reading dataexport const publicClient = createPublicClient({  chain: b3Mainnet,  transport: http()})// Wallet client for transactions (for server-side usage)export const walletClient = createWalletClient({  chain: b3Mainnet,  transport: http(),  account: privateKeyToAccount(process.env.PRIVATE_KEY as `0x${string}`)})

3. Environment Variables

Create a .env file in your project root:

bash
# Required for signing transactionsPRIVATE_KEY=0x...# Optional: Custom RPC endpointB3_MAINNET_RPC=https://your-custom-rpc.com

Framework Integration

Next.js Setup

For Next.js applications, create a configuration file:

typescript
import { createPublicClient, http } from 'viem'import { b3Mainnet } from '@b3dotfun/basemint'import {  CollectionManager,  RewardTracker,  BaseMintStorage} from '@b3dotfun/basemint'// Initialize clientsexport const publicClient = createPublicClient({  chain: b3Mainnet,  transport: http()})// Initialize CreateKit managersexport const collectionManager = new CollectionManager(publicClient)export const rewardTracker = new RewardTracker(publicClient)export const storage = new BaseMintStorage({  baseUrl: 'https://api.basemint.fun'})

React/Vite Setup

typescript
import { createPublicClient, http } from 'viem'import { b3Mainnet } from '@b3dotfun/basemint'import { CollectionManager } from '@b3dotfun/basemint'export const publicClient = createPublicClient({  chain: b3Mainnet,  transport: http(import.meta.env.VITE_RPC_URL)})export const collectionManager = new CollectionManager(publicClient)

Verify Installation

Test your installation with a simple script:

typescript
import { b3Mainnet, CollectionManager } from '@b3dotfun/basemint'import { createPublicClient, http } from 'viem'async function testInstallation() {  try {    // Create client    const client = createPublicClient({      chain: b3Mainnet,      transport: http()    })    // Initialize manager    const manager = new CollectionManager(client)    // Test connection    const blockNumber = await client.getBlockNumber()    console.log('✅ Successfully connected to B3 Mainnet')    console.log(`📊 Current block number: ${blockNumber}`)    // Test contract interaction    const factoryAddress = manager.getFactoryAddress()    console.log(`🏭 Factory address: ${factoryAddress}`)    console.log('🎉 CreateKit installation successful!')  } catch (error) {    console.error('❌ Installation test failed:', error)  }}testInstallation()

Run the test script:

bash
npx tsx test-installation.ts

bash
yarn tsx test-installation.ts

bash
pnpm tsx test-installation.ts

TypeScript Configuration

Ensure your tsconfig.json includes the necessary configurations:

json
{  "compilerOptions": {    "strict": true,    "moduleResolution": "node",    "allowSyntheticDefaultImports": true,    "esModuleInterop": true,    "skipLibCheck": true,    "target": "ES2020",    "module": "ESNext",    "lib": ["ES2020", "DOM"]  }}

Next Steps

Now that you have CreateKit installed and configured, you're ready to start building:

Troubleshooting

bash
npm install viem @wagmi/core