Back to Documentation
Getting Started
Set up your development environment and create your first pipeline.
Installation
Install the PIPELINK SDK and required dependencies using npm or yarn.
npm install @pipelink/sdk @solana/web3.js tweetnaclPrerequisites
Node.js
Version 16 or higher is required.
Solana CLI
Install from solana.com (optional but recommended)
Wallet
Phantom, Solflare, or another Solana-compatible wallet for testing.
Basic Usage
Here's a simple example to get you started with PIPELINK.
import { PipelineBuilder } from '@pipelink/sdk';
import { Connection, Keypair } from '@solana/web3.js';
// Initialize connection
const connection = new Connection('https://api.mainnet-beta.solana.com');
const keypair = Keypair.generate();
// Create a pipeline
const pipeline = new PipelineBuilder(connection)
.addStep('swap', {
tokenA: 'SOL',
tokenB: 'USDC',
amount: 1000000 // in lamports
})
.addStep('stake', {
amount: 500000,
duration: 30 // days
})
.build();
// Execute the pipeline
try {
const signature = await pipeline.execute(keypair);
console.log('Pipeline executed:', signature);
} catch (error) {
console.error('Pipeline failed:', error);
}Step-by-Step Guide
1
Initialize Connection
Create a Solana connection to the network (mainnet, devnet, or testnet).
const connection = new Connection('https://api.mainnet-beta.solana.com');2
Create Pipeline Builder
Instantiate a new PipelineBuilder with your connection.
const pipeline = new PipelineBuilder(connection);3
Add Steps
Add individual steps to your pipeline using the addStep method.
pipeline
.addStep('swap', { tokenA: 'SOL', tokenB: 'USDC', amount: 1000000 })
.addStep('stake', { amount: 500000 });4
Build and Execute
Build the pipeline and execute it with your keypair.
const builtPipeline = pipeline.build();
const signature = await builtPipeline.execute(keypair);Common Patterns
Conditional Execution
Execute different steps based on conditions.
const pipeline = new PipelineBuilder(connection)
.addStep('check_balance', { minimum: 1000000 })
.addCondition({
field: 'balance',
operator: '>=',
value: 1000000
})
.addStep('execute_trade', { amount: 500000 });Error Handling
Handle errors gracefully in your pipelines.
try {
const signature = await pipeline.execute(keypair);
console.log('Success:', signature);
} catch (error) {
if (error.code === 'INSUFFICIENT_FUNDS') {
console.log('Not enough SOL');
} else if (error.code === 'PROGRAM_FAILED') {
console.log('Instruction failed:', error.message);
}
}