Quick Start Guide
This guide will help you get started with Speedrun quickly, whether you're a user, developer, or fulfiller.
For Users
Making a Cross-Chain Transfer
- Visit speedrun.exchange
- Connect your wallet
- Select the source and destination chains
- Enter the amount and token
- Confirm the transaction
The transfer will be completed in seconds, with ZetaChain providing security guarantees.
For Developers
Basic Integration
-
Install Dependencies
npm install @speedrun/sdk
-
Initialize the SDK
import { Speedrun } from '@speedrun/sdk';
const speedrun = new Speedrun({
rpcUrl: 'YOUR_RPC_URL',
chainId: 42161 // Arbitrum
}); -
Create an Intent
const intent = await speedrun.createIntent({
asset: '0xaf88d065e77c8cc2239327c5edb3a432268e5831', // USDC
amount: '1000000000', // 1000 USDC
targetChain: 8453, // Base
receiver: '0x...', // Recipient address
tip: '3000000' // 3 USDC tip
}); -
Track Intent Status
const status = await speedrun.getIntentStatus(intent.id);
For Fulfillers
Setting Up a Fulfiller
-
Install Fulfiller Tools
npm install @speedrun/fulfiller
-
Configure Your Environment
cp .env.example .env
# Edit .env with your configuration -
Start the Fulfiller
npm run start
-
Monitor Fulfillments
# Check fulfillment status
curl -X GET "https://api.speedrun.exchange/api/v1/fulfillments/YOUR_FULFILLMENT_ID"
Next Steps
- Read the Architecture Overview to understand how Speedrun works
- Check out the API Reference for detailed endpoint documentation
- Review the Smart Contracts to access contract addresses
- Follow the Developer Guide to learn more about how to build applications powered by intents
- Follow the Fulfiller Guide to learn more about how to fulfill intents and get rewards
Common Issues
Transaction Failures
- Ensure sufficient gas on the source chain
- Verify token approvals
- Check for minimum transfer amounts
API Errors
- Verify API key and permissions
- Check rate limits
- Ensure correct chain IDs
Fulfillment Issues
- Verify liquidity on target chain
- Check gas prices
- Monitor for competing fulfillments