# Quickstart Guide ``` git clone https://github.com/elizaos/eliza.git ``` ### Prerequisites ๐Ÿ“‹ Before getting started with PePay, ensure you have: * **Node.js 23+** ๐ŸŸข\ [Download Node.js](https://nodejs.org/) * **pnpm 9+** ๐Ÿ“ฆ\ Install pnpm * **Git for version control** ๐Ÿ”„\ [Get Git](https://git-scm.com/) * **A code editor (VS Code or VSCodium recommended)** ๐Ÿ–ฅ๏ธ\ [Download VS Code](https://code.visualstudio.com/) * **CUDA Toolkit** (optional, for GPU acceleration) โšก\ [Install CUDA Toolkit](https://developer.nvidia.com/cuda-downloads) ### Installation ๐Ÿ”ง #### Clone and Install ๐Ÿ–‡๏ธ 1. **Clone the Repository**: ```bash bashCopyEditgit clone https://github.com/pepay/pepay.git ``` 2. **Enter the Directory**: ```bash bashCopyEditcd pepay ``` 3. **Switch to Latest Tagged Release**: ```bash bashCopyEditgit checkout $(git describe --tags --abbrev=0) ``` 4. **Install Dependencies** (for the initial run): ```bash bashCopyEditpnpm install --no-frozen-lockfile ``` Learn more about pnpm installation PEPAY is a decentralized AI payment gateway system designed to streamline transactions and interactions between blockchain ecosystems, AI agents, and end-user applications such as trading bots, retail purchases, DeSci, and gaming. It serves as a critical intermediary that leverages blockchain networks, AI libraries, and customer/inventory data to facilitate secure, efficient, and intelligent payment operations\ \ **Key Components** ## 1. Input Sources๐Ÿ“ฅ PePay integrates multiple blockchain ecosystems and AI libraries to gather transactional data and enable seamless payment functionality. **Blockchain Networks ๐ŸŒ** * Solana * Polygon * Binance Smart Chain (BSC) * Avalanche * Arbitrum **AI Agent Frameworks ๐Ÿค–** * Ai16z * ZeroBro * ARC * Virtuals * ElizaOS **LLM Frameworks ๐Ÿง ** * DeepSeek * Anthropic * Grok * ChatGPT * Gemini ## 2. Core Pepay Engineโš™๏ธ The PePay engine is the heart of the architecture, comprising the following modules: * **AI Agent Libraries**: Provide tools and frameworks for AI agents to process payment instructions and make intelligent decisions. ๐Ÿงฉ * **Non-Custodial Wallets**: Enable secure, decentralized storage and transfer of digital assets without intermediaries. ๐Ÿ”’ * **Customer Data**: A repository for user and client metadata to enhance personalization and transaction accuracy. ๐Ÿ—‚๏ธ * **Inventory Data**: Manages asset stock levels, ensuring reliable availability for AI-driven operations. ๐Ÿ“ฆ ## 2. **Core PEPAY Engine** ## 3. **AI Agents** AI Agents are the primary beneficiaries of PePay, utilizing the payment gatewayโ€™s tools to enable functionality in various domains: **Use Cases ๐Ÿ’ก** * **Trading Bots**: Execute automated trading strategies with real-time access to blockchain transactions and analytics. ๐Ÿ“ˆ * **Retail Purchases**: Facilitate e-commerce and point-of-sale transactions. ๐Ÿ›๏ธ * **DeSci (Decentralized Science)**: Drive decentralized funding, collaboration, and payments for scientific research projects. ๐Ÿ”ฌ * **Gaming**: Support in-game economies, micropayments, and cross-platform transactions. ๐ŸŽฎ ## Interactions & Overview๐Ÿ”„ Process Overview ๐ŸŒ€ ### Scalability and Extensibility ๐Ÿš€ ## API Documentation ๐Ÿ” ### ## Getting Started with PepePay ๐Ÿš€๐Ÿ’ฐ๐ŸŒŸ ### Prerequisites ๐Ÿ› ๏ธโœ…๐Ÿ“‹ Before diving into PepePay, ensure you have the following ready: * **Node.js 16+**: [Download Node.js](https://nodejs.org/). ๐Ÿ–ฅ๏ธโœจ * **A PepePay Account**: [Sign up for PepePay](https://pepepay.com/register). ๐Ÿ–Š๏ธ๐Ÿ”‘ * **Git for Version Control**: [Install Git](https://git-scm.com/). ๐Ÿ“‚๐Ÿ”„ * **Code Editor**: [Download VS Code](https://code.visualstudio.com/). ๐Ÿ–Œ๏ธ๐Ÿ“˜ ### Installation ๐Ÿ–ฅ๏ธ๐Ÿ“ฆโœจ Follow these steps to set up PepePay on your local environment: 1. **Clone the Repository** ๐Ÿ› ๏ธ: ```bash git clone https://github.com/pepepay/pepepay.git ``` 2. **Enter the Directory** ๐Ÿ“‚: ```bash cd pepepay ``` 3. **Install Dependencies** ๐Ÿ“ฅ: ```bash npm install ``` 4. **Build the Project** ๐Ÿ—๏ธ: ```bash npm run build ``` 5. **Configure Environment Variables** ๐Ÿ”ง: Copy the example `.env` file and customize it for your setup: ```bash cp .env.example .env ``` Edit `.env` to include your keys: ``` API_KEY=your_api_key_here WEBHOOK_URL=https://yourdomain.com/webhook ``` ### Choose Your Payment Model ๐Ÿ”„๐Ÿ’ต๐Ÿ’ก PepePay supports various payment models to suit your business needs: * **Hosted Payment Links** ๐ŸŒ: Perfect for quick payment setups. * **Embeddable Iframes** ๐Ÿ–ผ๏ธ: Seamlessly integrate with your website. * **API Integration** ๐Ÿ”‘: Build custom payment flows with full flexibility. Refer to the [PepePay API Documentation](https://pepepay.com/docs/api) for detailed setup instructions. ๐Ÿ“šโœจ ### Local Testing & Inference ๐Ÿงชโš™๏ธ๐Ÿ” Set up a local testing environment to simulate payments: 1. **Start the Local Server** ๐Ÿ–ฅ๏ธ: ```bash npm run start ``` 2. **Access the Dashboard** ๐Ÿ“Š: Open [http://localhost:3000](http://localhost:3000/) in your browser. ๐ŸŒโœจ 3. **Simulate Payments** ๐Ÿ’ณ: Use the dashboard to create invoices and test payment flows. ๐Ÿ”„๐Ÿ’ก ### Create Your First Invoice ๐Ÿงพ๐Ÿ“ฅ๐ŸŽ‰ 1. **Log In to Your Account** ๐Ÿ”: Visit [PepePay Login](https://pepepay.com/login) and enter your credentials. ๐Ÿ”‘โœจ 2. **Navigate to Invoices** ๐Ÿ“‚: Go to the "Invoices" section in the dashboard. ๐Ÿ“Š๐Ÿ“˜ 3. **Fill in Details** ๐Ÿ“: * Enter the amount in USD. * Select accepted cryptocurrencies. * Add optional metadata (e.g., order ID). ๐Ÿ’ต๐Ÿงพ 4. **Generate Invoice** ๐Ÿ”„: Click "Create" to generate the payment link or iframe. ๐ŸŒโœจ ### Platform Integration ๐ŸŒ๐Ÿ”—๐Ÿ“œ PePay offers integrations with popular platforms: #### Discord Bot Setup ๐Ÿค–๐Ÿ’ฌโœจ 1. **Create a Bot**: * Visit the [Discord Developer Portal](https://discord.com/developers/applications). ๐Ÿ”— * Create a new application and generate a bot token. ๐Ÿ”‘ 2. **Configure PepePay**: * Add your bot token to `.env`: ``` DISCORD_BOT_TOKEN=your_discord_token_here ``` 3. **Run the Bot**: ```bash npm run discord-bot ``` 4. **Add to Server**: Use the OAuth2 URL to invite the bot to your Discord server. ๐Ÿ’ฌโœจ ### Basic Usage Examples ๐Ÿ› ๏ธ๐Ÿ“š๐ŸŽฏ #### Chat with PePay ๐Ÿ’ฌ๐Ÿ’ก Start the chat interface to interact with PePay: ```bash npm run chat ``` #### Create Multiple Invoices ๐Ÿ“Š๐Ÿ“‚ Use the dashboard or API to create and manage multiple invoices at once. ๐Ÿš€๐ŸŽ‰ ### Common Issues & Solutions ๐Ÿ”งโ“โœ… 1. **Node.js Version Error**: * Ensure Node.js 16+ is installed. Use: ```bash node -v ``` 2. **Missing Dependencies**: * Run: ```bash npm install ``` 3. **Environment Variable Issues**: * Verify `.env` is correctly configured. ๐ŸŒŸ๐Ÿ” ### Next Steps ๐ŸŒŸ๐Ÿš€๐Ÿ“ˆ Now that youโ€™re set up, explore: * [**Advanced Features**](https://pepepay.com/docs/advanced): Dive deeper into PePayโ€™s capabilities. ๐Ÿ“˜โœจ * [**Join the Community**](https://pepepay.com/community): Connect with other users and developers. ๐Ÿ’ฌ๐ŸŒŸ * [**API Documentation**](https://pepepay.com/docs/api): Build custom integrations with our detailed API docs. ๐Ÿ“š๐Ÿ”— --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.pepay.io/developers/quickstart-1.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.