Get up and running with B3 SDK in under 5 minutes
``` -------------------------------- ### B3 SDK Quickstart Source: https://docs.b3.fun/llms A guide to getting started with the B3 SDK quickly to begin building on the B3 ecosystem. ```en Get started with the B3 SDK in minutes and start building on the B3 ecosystem ``` -------------------------------- ### B3 Quick Start Guide Source: https://docs.b3.fun/bondkit/api A guide to help users get started with the B3 SDK quickly, aiming for setup in under 5 minutes. It provides a streamlined path to begin development on the B3 platform. ```APIDOC Quick Start Guide: Purpose: Get up and running with B3 SDK in under 5 minutes. Link: https://docs.b3.fun/quickstart ``` -------------------------------- ### B3 CreateKit Quickstart Example Source: https://docs.b3.fun/createkit/quickstart This TypeScript script demonstrates the end-to-end process of creating an NFT collection using B3 CreateKit. It covers initializing viem clients, setting up CreateKit services, generating signatures, storing collection metadata, deploying the collection, minting an NFT, and tracking rewards. It relies on environment variables for private keys and specific B3 testnet configurations. ```typescript import { CollectionManager, RewardTracker, BaseMintStorage, b3Testnet } from '@b3dotfun/basemint' import { createPublicClient, createWalletClient, http } from 'viem' import { privateKeyToAccount } from 'viem/accounts' async function quickstart() { // Initialize clients const publicClient = createPublicClient({ chain: b3Testnet, transport: http() }) const account = privateKeyToAccount(process.env.PRIVATE_KEY as `0x${string}`) const walletClient = createWalletClient({ chain: b3Testnet, transport: http(), account }) // Initialize CreateKit services const collectionManager = new CollectionManager(publicClient) const rewardTracker = new RewardTracker(publicClient) const storage = new BaseMintStorage({ baseUrl: 'https://api.basemint.fun' }) // Step 1: Create collection metadata const collectionMetadata = { name: "My First Collection", symbol: "MFC", creator: account.address, gameOwner: account.address, maxSupply: 1000n, mintPrice: 0n, maxPerWallet: 10n, description: "My first NFT collection on B3", image: "https://example.com/collection-image.png", startTime: 0n, endTime: BigInt(Math.floor(Date.now() / 1000) + 86400 * 30), tokenStandard: "ERC721" as const, chainId: 1993 } // Step 2: Generate signatures const creatorSignature = await collectionManager.generateCreatorSignature( walletClient, collectionMetadata ) const predictedAddress = collectionManager.predictCollectionAddress( collectionMetadata, creatorSignature ) console.log(`π Predicted collection address: ${predictedAddress}`) // Step 3: Submit to storage try { await storage.submitCollection(collectionMetadata, creatorSignature) console.log("β Collection metadata stored successfully") } catch (error) { console.error("β Failed to store collection:", error) return } // Step 4: Deploy and mint const deployerSignature = await collectionManager.generateDeployerSignature( walletClient, predictedAddress ) const collection = collectionManager.createCollection( predictedAddress, collectionMetadata.tokenStandard ) const mintTx = await collection.mint( walletClient, 1n, undefined, 0n, [], creatorSignature, deployerSignature ) console.log(`π Collection deployed and first NFT minted!`) console.log(`π Transaction hash: ${mintTx}`) // Step 5: Verify deployment const isDeployed = await collection.isDeployed() console.log(`π Collection deployed: ${isDeployed}`) // Step 6: Track rewards const escrowAddress = collectionManager.getEscrowAddress() const collectionRewards = await rewardTracker.getCollectionRewards( escrowAddress, predictedAddress ) console.log("π Collection Rewards:", { totalRewards: collectionRewards.totalRewards.toString(), unclaimedRewards: collectionRewards.unclaimedRewards.toString(), totalMints: collectionRewards.totalMints.toString() }) } // Run the quickstart quickstart().catch(console.error) ``` -------------------------------- ### Project Setup with BondKit Source: https://docs.b3.fun/bondkit/installation Sets up a new project for BondKit development. This includes creating a project directory, initializing it with pnpm, installing necessary dependencies like the SDK and TypeScript, and generating a tsconfig.json file. ```bash # Create a new project mkdir my-bondkit-app cd my-bondkit-app pnpm init # Install dependencies pnpm add @b3dotfun/sdk typescript pnpm add -D @types/node tsx # Create TypeScript config npx tsc --init ``` -------------------------------- ### Running the B3 CreateKit Quickstart Script Source: https://docs.b3.fun/createkit/quickstart This command executes the TypeScript quickstart script using `tsx`, a tool that allows running TypeScript files directly without prior compilation. Ensure you have `tsx` installed (`npm install -g tsx` or `yarn global add tsx`) and your environment variables (like `PRIVATE_KEY`) are set. ```bash npx tsx quickstart.ts ``` -------------------------------- ### BondKit Workflow and Setup Source: https://docs.b3.fun/llms Information on how BondKit works, installation, and quickstart guides for launching ERC20 bond tokens. ```APIDOC How BondKit Works: Description: Create β Bond β Migrate: the endβtoβend flow for launching ERC20 bond tokens on Base. Installation: Description: Install and configure BondKit for launching ERC20 bond tokens on Base. Quickstart: Description: Launch an ERC20 bond token in minutes: Create β Bond β Migrate. ``` -------------------------------- ### React/Vite Setup with CreateKit Source: https://docs.b3.fun/createkit/installation Sets up viem clients and the CollectionManager for React/Vite applications using B3 Testnet and environment variables for the RPC URL. ```typescript import { createPublicClient, http } from 'viem' import { b3Testnet } from '@b3dotfun/basemint' import { CollectionManager } from '@b3dotfun/basemint' export const publicClient = createPublicClient({ chain: b3Testnet, transport: http(import.meta.env.VITE_RPC_URL) }) export const collectionManager = new CollectionManager(publicClient) ``` -------------------------------- ### Running BondKit Setup Test Source: https://docs.b3.fun/bondkit/installation Command to execute the BondKit setup test file using `tsx`. ```bash npx tsx test-bondkit.ts ``` -------------------------------- ### Advanced BondKit Setup with Custom Wallet Client Source: https://docs.b3.fun/bondkit/installation Illustrates an advanced setup for BondKit, including custom wallet client configuration using viem and connecting the BondkitTokenFactory with a custom transport. It also shows how to initialize and work with an existing BondKit token. ```typescript import { BondkitTokenFactory, BondkitToken, getConfig } from "@b3dotfun/sdk/bondkit"; import { createWalletClient, custom } from "viem"; import { base } from "viem/chains"; // Custom wallet client setup const walletClient = createWalletClient({ chain: base, transport: custom(window.ethereum) }); // Initialize with custom configuration const config = getConfig(base.id); const factory = new BondkitTokenFactory(base.id); // Connect with custom wallet client await factory.connect(walletClient.transport); // Work with existing token const token = new BondkitToken( "0x123...", // token address process.env.WALLET_PRIVATE_KEY ); ``` -------------------------------- ### Next.js Setup with CreateKit Source: https://docs.b3.fun/createkit/installation Initializes viem clients and CreateKit managers (CollectionManager, RewardTracker, BaseMintStorage) for a Next.js application using B3 Testnet. ```typescript import { createPublicClient, http } from 'viem' import { b3Testnet } from '@b3dotfun/basemint' import { CollectionManager, RewardTracker, BaseMintStorage } from '@b3dotfun/basemint' // Initialize clients export const publicClient = createPublicClient({ chain: b3Testnet, transport: http() }) // Initialize CreateKit managers export const collectionManager = new CollectionManager(publicClient) export const rewardTracker = new RewardTracker(publicClient) export const storage = new BaseMintStorage({ baseUrl: 'https://api.basemint.fun' }) ``` -------------------------------- ### Initialize Viem Clients with CreateKit Source: https://docs.b3.fun/createkit/installation Provides examples for initializing both public and wallet viem clients using CreateKit's chain definitions. The public client is for reading data, while the wallet client is for signing transactions, typically used server-side. ```typescript import { createPublicClient, createWalletClient, http } from 'viem' import { privateKeyToAccount } from 'viem/accounts' import { b3Testnet } from '@b3dotfun/basemint' // Public client for reading data export const publicClient = createPublicClient({ chain: b3Testnet, transport: http() }) // Wallet client for transactions (for server-side usage) export const walletClient = createWalletClient({ chain: b3Testnet, transport: http(), account: privateKeyToAccount(process.env.PRIVATE_KEY as `0x${string}`) }) ``` -------------------------------- ### CreateKit SDK: Core Functionality Guides Source: https://docs.b3.fun/llms Guides covering the core functionalities of the CreateKit SDK. This includes installation, a quick start for creating your first NFT collection, detailed minting processes, and managing the rewards system. ```APIDOC Installation: Install CreateKit (BaseMint SDK) in your project. Quick Start: Create your first NFT collection with CreateKit in minutes. Minting: Guides on token minting, including deployment, regular minting, and advanced features. Rewards System: Understanding and implementing the CreateKit reward distribution system. ``` -------------------------------- ### Verify AnySpend Setup Source: https://docs.b3.fun/anyspend/installation A simple React component to verify that the AnySpend setup is working correctly by rendering the AnySpend component. ```javascript import { AnySpend } from "@b3dotfun/sdk/anyspend/react"; function TestComponent() { returnFirst, connect your wallet to continue.
Purchase tokens with your credit card to get started.
Your crypto purchase is complete. Here's what you can do next: